{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key WM 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.entitydelete+json", "application/vnd.onkey.entitydeletecollection+json", "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitymatchupdatecollection+json", "multipart/form-data" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json", "*/*" ], "paths": { "/Modules/WM/DueTasks/{id}": { "get": { "tags": [ "Due Task" ], "summary": "Get a Due Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | DueTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | DueTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | DueTask->PermissionTree_Description | string | |\r\n| id | DueTask->Id | integer | int64 |\r\n| version | DueTask->Version | integer | int32 |\r\n| assetId | DueTask->Asset_Id | integer | int64 |\r\n| assetCode | DueTask->Asset_Code | string | |\r\n| assetDescription | DueTask->Asset_Description | string | |\r\n| defaultIntervalId | DueTask->DefaultInterval_Id | integer | int64 |\r\n| defaultIntervalCode | DueTask->DefaultInterval_Code | string | |\r\n| defaultIntervalDescription | DueTask->DefaultInterval_Description | string | |\r\n| dueDate | DueTask->DueDate | string | date |\r\n| dueReading | DueTask->DueReading | number | decimal |\r\n| eventId | DueTask->Event_Id | integer | int64 |\r\n| eventCode | DueTask->Event_Code | string | |\r\n| eventDescription | DueTask->Event_Description | string | |\r\n| generatedOn | DueTask->GeneratedOn | string | date |\r\n| interval1DueDate | DueTask->Interval1DueDate | string | date |\r\n| interval2DueDate | DueTask->Interval2DueDate | string | date |\r\n| intervalTypeId | DueTask->IntervalType_Id | integer | int64 |\r\n| intervalTypeCode | DueTask->IntervalType_Code | string | |\r\n| intervalTypeDescription | DueTask->IntervalType_Description | string | |\r\n| intervalTypeSchedulingKind | DueTask->IntervalType_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isSuppressed | DueTask->IsSuppressed | boolean | |\r\n| outOfBoundsTask | DueTask->OutOfBoundsTask | boolean | |\r\n| regularAssetTaskId | DueTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | DueTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | DueTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIsActive | DueTask->RegularAssetTask_IsActive | boolean | |\r\n| schedulingKind | DueTask->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| suppressionType | DueTask->SuppressionType | string (Allowed values: [SuppressorFutureDate, Window, LastDoneInOpenWorkOrder, LastDone]) | enum |\r\n| usedActualInterval | DueTask->UsedActualInterval | number | decimal |\r\n", "operationId": "GetDueTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Due Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Due Task", "schema": { "$ref": "#/definitions/GetDueTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Due Task" ], "summary": "Delete an existing Due Task 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 | DueTask->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": "DeleteDueTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Due Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDueTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Due Task 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/WM/DueTasks": { "get": { "tags": [ "Due Task" ], "summary": "Get a collection of Due Task resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DueTask->Id | integer | int64 |\r\n| version | DueTask->Version | integer | int32 |\r\n| generatedOn | DueTask->GeneratedOn | string | date |\r\n| dueDate | DueTask->DueDate | string | date |\r\n| dueReading | DueTask->DueReading | number | decimal |\r\n| interval1DueDate | DueTask->Interval1DueDate | string | date |\r\n| interval2DueDate | DueTask->Interval2DueDate | string | date |\r\n| isSuppressed | DueTask->IsSuppressed | boolean | |\r\n| suppressionType | DueTask->SuppressionType | string (Allowed values: [SuppressorFutureDate, Window, LastDoneInOpenWorkOrder, LastDone]) | enum |\r\n| assetCode | DueTask->Asset_Code | string | |\r\n| regularAssetTaskCode | DueTask->RegularAssetTask_Code | string | |\r\n| outOfBoundsTask | DueTask->OutOfBoundsTask | boolean | |\r\n", "operationId": "GetDueTaskCollection", "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 Due Task collection", "schema": { "$ref": "#/definitions/GetDueTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/DueTasks/Batch/{ids}": { "get": { "tags": [ "Due Task" ], "summary": "Get a collection of Due Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | DueTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | DueTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | DueTask->PermissionTree_Description | string | |\r\n| id | DueTask->Id | integer | int64 |\r\n| version | DueTask->Version | integer | int32 |\r\n| assetId | DueTask->Asset_Id | integer | int64 |\r\n| assetCode | DueTask->Asset_Code | string | |\r\n| assetDescription | DueTask->Asset_Description | string | |\r\n| defaultIntervalId | DueTask->DefaultInterval_Id | integer | int64 |\r\n| defaultIntervalCode | DueTask->DefaultInterval_Code | string | |\r\n| defaultIntervalDescription | DueTask->DefaultInterval_Description | string | |\r\n| dueDate | DueTask->DueDate | string | date |\r\n| dueReading | DueTask->DueReading | number | decimal |\r\n| eventId | DueTask->Event_Id | integer | int64 |\r\n| eventCode | DueTask->Event_Code | string | |\r\n| eventDescription | DueTask->Event_Description | string | |\r\n| generatedOn | DueTask->GeneratedOn | string | date |\r\n| interval1DueDate | DueTask->Interval1DueDate | string | date |\r\n| interval2DueDate | DueTask->Interval2DueDate | string | date |\r\n| intervalTypeId | DueTask->IntervalType_Id | integer | int64 |\r\n| intervalTypeCode | DueTask->IntervalType_Code | string | |\r\n| intervalTypeDescription | DueTask->IntervalType_Description | string | |\r\n| intervalTypeSchedulingKind | DueTask->IntervalType_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isSuppressed | DueTask->IsSuppressed | boolean | |\r\n| outOfBoundsTask | DueTask->OutOfBoundsTask | boolean | |\r\n| regularAssetTaskId | DueTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | DueTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | DueTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIsActive | DueTask->RegularAssetTask_IsActive | boolean | |\r\n| schedulingKind | DueTask->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| suppressionType | DueTask->SuppressionType | string (Allowed values: [SuppressorFutureDate, Window, LastDoneInOpenWorkOrder, LastDone]) | enum |\r\n| usedActualInterval | DueTask->UsedActualInterval | number | decimal |\r\n", "operationId": "BatchGetDueTask", "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 Due Task 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 Due Task collection", "schema": { "$ref": "#/definitions/BatchGetDueTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/DueTasks/Batch": { "delete": { "tags": [ "Due Task" ], "summary": "Delete a collection of existing Due Task 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 | DueTask->Id | integer | int64 |\r\n| version | DueTask->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": "BatchDeleteDueTask", "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/BatchDeleteDueTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Due Task 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/WM/DueTasks/Suppressors/{id}": { "get": { "tags": [ "Due Task Suppressor" ], "summary": "Get a Due Task Suppressor 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 | DueTaskSuppressor->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DueTaskSuppressor->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DueTaskSuppressor->CreatedByUser_FullName | string | |\r\n| createdOn | DueTaskSuppressor->CreatedOn | string | date-time |\r\n| modifiedByUserId | DueTaskSuppressor->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DueTaskSuppressor->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DueTaskSuppressor->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DueTaskSuppressor->ModifiedOn | string | date-time |\r\n| version | DueTaskSuppressor->Version | integer | int32 |\r\n| id | DueTaskSuppressor->Id | integer | int64 |\r\n| suppressedDueTaskId | DueTaskSuppressor->SuppressedDueTask_Id | integer | int64 |\r\n| suppressedDueTaskRegularAssetTaskId | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Id | integer | int64 |\r\n| suppressedDueTaskRegularAssetTaskCode | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Code | string | |\r\n| suppressedDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description | string | |\r\n| suppressedFrom | DueTaskSuppressor->SuppressedFrom | string | date |\r\n| suppressedTo | DueTaskSuppressor->SuppressedTo | string | date |\r\n| suppressionType | DueTaskSuppressor->SuppressionType | string (Allowed values: [SuppressorFutureDate, Window, LastDoneInOpenWorkOrder, LastDone]) | enum |\r\n| suppressorDueTaskId | DueTaskSuppressor->SuppressorDueTask_Id | integer | int64 |\r\n| suppressorDueTaskRegularAssetTaskId | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Id | integer | int64 |\r\n| suppressorDueTaskRegularAssetTaskCode | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Code | string | |\r\n| suppressorDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Description | string | |\r\n", "operationId": "GetDueTaskSuppressor", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Due Task Suppressor Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Due Task Suppressor", "schema": { "$ref": "#/definitions/GetDueTaskSuppressorResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/DueTasks/Suppressors": { "get": { "tags": [ "Due Task Suppressor" ], "summary": "Get a collection of Due Task Suppressor 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 | DueTaskSuppressor->Id | integer | int64 |\r\n| suppressedDueTaskId | DueTaskSuppressor->SuppressedDueTask_Id | integer | int64 |\r\n| suppressedDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description | string | |\r\n| suppressedFrom | DueTaskSuppressor->SuppressedFrom | string | date |\r\n| suppressedTo | DueTaskSuppressor->SuppressedTo | string | date |\r\n| suppressorDueTaskId | DueTaskSuppressor->SuppressorDueTask_Id | integer | int64 |\r\n| suppressorDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Description | string | |\r\n| createdOn | DueTaskSuppressor->CreatedOn | string | date-time |\r\n| modifiedOn | DueTaskSuppressor->ModifiedOn | string | date-time |\r\n", "operationId": "GetDueTaskSuppressorCollection", "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 Due Task Suppressor collection", "schema": { "$ref": "#/definitions/GetDueTaskSuppressorCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/DueTasks/{id}/Suppressors": { "get": { "tags": [ "Due Task Suppressor" ], "summary": "Get a collection of Due Task Suppressor resources for the Due Task.", "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 | DueTaskSuppressor->Id | integer | int64 |\r\n| suppressedDueTaskId | DueTaskSuppressor->SuppressedDueTask_Id | integer | int64 |\r\n| suppressedDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description | string | |\r\n| suppressedFrom | DueTaskSuppressor->SuppressedFrom | string | date |\r\n| suppressedTo | DueTaskSuppressor->SuppressedTo | string | date |\r\n| suppressorDueTaskId | DueTaskSuppressor->SuppressorDueTask_Id | integer | int64 |\r\n| suppressorDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Description | string | |\r\n| createdOn | DueTaskSuppressor->CreatedOn | string | date-time |\r\n| modifiedOn | DueTaskSuppressor->ModifiedOn | string | date-time |\r\n", "operationId": "GetDueTaskSuppressorForDueTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Due Task 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 Due Task Suppressor collection", "schema": { "$ref": "#/definitions/GeDueTaskSuppressorForCollectionDueTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/DueTasks/Suppressors/Batch/{ids}": { "get": { "tags": [ "Due Task Suppressor" ], "summary": "Get a collection of Due Task Suppressor 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 | DueTaskSuppressor->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | DueTaskSuppressor->CreatedByUser_Code | string | |\r\n| createdByUserFullName | DueTaskSuppressor->CreatedByUser_FullName | string | |\r\n| createdOn | DueTaskSuppressor->CreatedOn | string | date-time |\r\n| modifiedByUserId | DueTaskSuppressor->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | DueTaskSuppressor->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | DueTaskSuppressor->ModifiedByUser_FullName | string | |\r\n| modifiedOn | DueTaskSuppressor->ModifiedOn | string | date-time |\r\n| version | DueTaskSuppressor->Version | integer | int32 |\r\n| id | DueTaskSuppressor->Id | integer | int64 |\r\n| suppressedDueTaskId | DueTaskSuppressor->SuppressedDueTask_Id | integer | int64 |\r\n| suppressedDueTaskRegularAssetTaskId | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Id | integer | int64 |\r\n| suppressedDueTaskRegularAssetTaskCode | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Code | string | |\r\n| suppressedDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description | string | |\r\n| suppressedFrom | DueTaskSuppressor->SuppressedFrom | string | date |\r\n| suppressedTo | DueTaskSuppressor->SuppressedTo | string | date |\r\n| suppressionType | DueTaskSuppressor->SuppressionType | string (Allowed values: [SuppressorFutureDate, Window, LastDoneInOpenWorkOrder, LastDone]) | enum |\r\n| suppressorDueTaskId | DueTaskSuppressor->SuppressorDueTask_Id | integer | int64 |\r\n| suppressorDueTaskRegularAssetTaskId | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Id | integer | int64 |\r\n| suppressorDueTaskRegularAssetTaskCode | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Code | string | |\r\n| suppressorDueTaskRegularAssetTaskDescription | DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Description | string | |\r\n", "operationId": "BatchGetDueTaskSuppressor", "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 Due Task Suppressor 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 Due Task Suppressor collection", "schema": { "$ref": "#/definitions/BatchGetDueTaskSuppressorResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/GenerateProposedWorkOrders/Defaults": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Get the System Option defaults for generation of collection of Proposed Work Order 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| proposedWorkOrdersFutureRange | GenerateProposedWorkOrdersFilterDefaultSystemOptionValues->ProposedWorkOrdersFutureRange | integer | int32 |\r\n| proposedWorkDefaultGroupingInterval | GenerateProposedWorkOrdersFilterDefaultSystemOptionValues->ProposedWorkDefaultGroupingInterval | integer | int32 |\r\n| proposedWorkDefaultTaskGroupingStartDate | GenerateProposedWorkOrdersFilterDefaultSystemOptionValues->ProposedWorkDefaultTaskGroupingStartDate | string | date-time |\r\n", "operationId": "GetGenerateProposedWorkOrdersSystemOptionDefaults", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Proposed Work Order", "schema": { "$ref": "#/definitions/GetGenerateProposedWorkOrdersSystemOptionDefaultsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/GenerateWorkOrders/Defaults": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Get the System Option defaults for generation of Work Orders", "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| combineResourcesOnSingleTask | GenerateWorkOrdersDefaultSystemOptionValues->CombineResourcesOnSingleTask | string (Allowed values: [AlwaysAsk, Always, Never]) | enum |\r\n", "operationId": "GetGenerateWorkOrdersSystemOptionDefaults", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Proposed Work Order", "schema": { "$ref": "#/definitions/GetGenerateWorkOrdersSystemOptionDefaultsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/{id}": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Get a Proposed Work Order 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 | ProposedWorkOrder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ProposedWorkOrder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ProposedWorkOrder->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrder->CreatedOn | string | date-time |\r\n| modifiedByUserId | ProposedWorkOrder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ProposedWorkOrder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ProposedWorkOrder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ProposedWorkOrder->ModifiedOn | string | date-time |\r\n| version | ProposedWorkOrder->Version | integer | int32 |\r\n| permissionTreeId | ProposedWorkOrder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ProposedWorkOrder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ProposedWorkOrder->PermissionTree_Description | string | |\r\n| siteId | ProposedWorkOrder->Site_Id | integer | int64 |\r\n| siteCode | ProposedWorkOrder->Site_Code | string | |\r\n| siteDescription | ProposedWorkOrder->Site_Description | string | |\r\n| id | ProposedWorkOrder->Id | integer | int64 |\r\n| assetId | ProposedWorkOrder->Asset_Id | integer | int64 |\r\n| assetCode | ProposedWorkOrder->Asset_Code | string | |\r\n| assetDescription | ProposedWorkOrder->Asset_Description | string | |\r\n| defaultIntervalId | ProposedWorkOrder->DefaultInterval_Id | integer | int64 |\r\n| defaultIntervalCode | ProposedWorkOrder->DefaultInterval_Code | string | |\r\n| defaultIntervalDescription | ProposedWorkOrder->DefaultInterval_Description | string | |\r\n| defaultIntervalTaskIntervalTypeId | ProposedWorkOrder->DefaultInterval_TaskIntervalType_Id | integer | int64 |\r\n| description | ProposedWorkOrder->Description | string | |\r\n| downtime | ProposedWorkOrder->Downtime | string | duration |\r\n| dueDate | ProposedWorkOrder->DueDate | string | date |\r\n| duration | ProposedWorkOrder->Duration | string | duration |\r\n| eventId | ProposedWorkOrder->Event_Id | integer | int64 |\r\n| eventCode | ProposedWorkOrder->Event_Code | string | |\r\n| eventDescription | ProposedWorkOrder->Event_Description | string | |\r\n| intervalTypeId | ProposedWorkOrder->IntervalType_Id | integer | int64 |\r\n| intervalTypeCode | ProposedWorkOrder->IntervalType_Code | string | |\r\n| intervalTypeDescription | ProposedWorkOrder->IntervalType_Description | string | |\r\n| intervalTypeSchedulingKind | ProposedWorkOrder->IntervalType_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| machineState | ProposedWorkOrder->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| mainScheduledReading | ProposedWorkOrder->MainScheduledReading | number | decimal |\r\n| minStartDate | ProposedWorkOrder->MinStartDate | string | date |\r\n| motionType | ProposedWorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| proposedWorkOrderBatchId | ProposedWorkOrder->ProposedWorkOrderBatch_Id | integer | int64 |\r\n| responsibleSectionId | ProposedWorkOrder->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | ProposedWorkOrder->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | ProposedWorkOrder->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | ProposedWorkOrder->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | ProposedWorkOrder->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceDescription | ProposedWorkOrder->ResponsibleStaffMemberResource_Description | string | |\r\n| responsibleStaffMemberResourceResourceType | ProposedWorkOrder->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleStaffMemberResourceContactDetailDepartment | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailDepartment | string | |\r\n| responsibleStaffMemberResourceContactDetailJobTitle | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailJobTitle | string | |\r\n| responsibleStaffMemberResourceSiteId | ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Id | integer | int64 |\r\n| responsibleStaffMemberResourceSiteCode | ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Code | string | |\r\n| responsibleStaffMemberResourceSiteDescription | ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Description | string | |\r\n| responsibleTradeId | ProposedWorkOrder->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | ProposedWorkOrder->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | ProposedWorkOrder->ResponsibleTrade_Description | string | |\r\n| status | ProposedWorkOrder->Status | string (Allowed values: [CanGenerateWorkOrder, WorkOrderGenerated, AllTasksSuppressed, ConfigurationIncomplete]) | enum |\r\n| taskClassification1Id | ProposedWorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | ProposedWorkOrder->TaskClassification1_Code | string | |\r\n| taskClassification1Description | ProposedWorkOrder->TaskClassification1_Description | string | |\r\n| taskClassification2Id | ProposedWorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | ProposedWorkOrder->TaskClassification2_Code | string | |\r\n| taskClassification2Description | ProposedWorkOrder->TaskClassification2_Description | string | |\r\n| taskClassification3Id | ProposedWorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | ProposedWorkOrder->TaskClassification3_Code | string | |\r\n| taskClassification3Description | ProposedWorkOrder->TaskClassification3_Description | string | |\r\n| taskClassification4Id | ProposedWorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | ProposedWorkOrder->TaskClassification4_Code | string | |\r\n| taskClassification4Description | ProposedWorkOrder->TaskClassification4_Description | string | |\r\n| taskClassification5Id | ProposedWorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | ProposedWorkOrder->TaskClassification5_Code | string | |\r\n| taskClassification5Description | ProposedWorkOrder->TaskClassification5_Description | string | |\r\n| taskClassification6Id | ProposedWorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | ProposedWorkOrder->TaskClassification6_Code | string | |\r\n| taskClassification6Description | ProposedWorkOrder->TaskClassification6_Description | string | |\r\n| taskClassification7Id | ProposedWorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | ProposedWorkOrder->TaskClassification7_Code | string | |\r\n| taskClassification7Description | ProposedWorkOrder->TaskClassification7_Description | string | |\r\n| taskClassification8Id | ProposedWorkOrder->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | ProposedWorkOrder->TaskClassification8_Code | string | |\r\n| taskClassification8Description | ProposedWorkOrder->TaskClassification8_Description | string | |\r\n| typeOfWorkId | ProposedWorkOrder->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | ProposedWorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | ProposedWorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | ProposedWorkOrder->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | ProposedWorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workOrderId | ProposedWorkOrder->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | ProposedWorkOrder->WorkOrder_Code | string | |\r\n| workOrderDescription | ProposedWorkOrder->WorkOrder_Description | string | |\r\n| workOrderGeneratedOn | ProposedWorkOrder->WorkOrderGeneratedOn | string | date-time |\r\n| workOrderGenerationMessage | ProposedWorkOrder->WorkOrderGenerationMessage | string | |\r\n", "operationId": "GetProposedWorkOrder", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Proposed Work Order", "schema": { "$ref": "#/definitions/GetProposedWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Proposed Work Order" ], "summary": "Delete an existing Proposed Work Order 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 | ProposedWorkOrder->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": "DeleteProposedWorkOrder", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteProposedWorkOrderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Proposed Work Order 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/WM/ProposedWorkOrders/Batches": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Get a collection of Proposed Work Order 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 | ProposedWorkOrderBatch->Version | integer | int32 |\r\n| id | ProposedWorkOrderBatch->Id | integer | int64 |\r\n| name | ProposedWorkOrderBatch->Name | string | |\r\n| createdByUserFullName | ProposedWorkOrderBatch->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrderBatch->CreatedOn | string | date-time |\r\n", "operationId": "GetProposedWorkOrderBatchCollection", "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 Proposed Work Order collection", "schema": { "$ref": "#/definitions/GetProposedWorkOrderBatchCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Get a collection of Proposed Work Order 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 | ProposedWorkOrder->Id | integer | int64 |\r\n| version | ProposedWorkOrder->Version | integer | int32 |\r\n| status | ProposedWorkOrder->Status | string (Allowed values: [CanGenerateWorkOrder, WorkOrderGenerated, AllTasksSuppressed, ConfigurationIncomplete]) | enum |\r\n| siteCode | ProposedWorkOrder->Site_Code | string | |\r\n| assetCode | ProposedWorkOrder->Asset_Code | string | |\r\n| assetDescription | ProposedWorkOrder->Asset_Description | string | |\r\n| dueDate | ProposedWorkOrder->DueDate | string | date |\r\n| mainScheduledReading | ProposedWorkOrder->MainScheduledReading | number | decimal |\r\n| description | ProposedWorkOrder->Description | string | |\r\n| workOrderCode | ProposedWorkOrder->WorkOrder_Code | string | |\r\n| workOrderGeneratedOn | ProposedWorkOrder->WorkOrderGeneratedOn | string | date-time |\r\n| workOrderGenerationMessage | ProposedWorkOrder->WorkOrderGenerationMessage | string | |\r\n| proposedWorkOrderBatchId | ProposedWorkOrder->ProposedWorkOrderBatch_Id | integer | int64 |\r\n| proposedWorkOrderBatchName | ProposedWorkOrder->ProposedWorkOrderBatch_Name | string | |\r\n| proposedWorkOrderBatchCreatedOn | ProposedWorkOrder->ProposedWorkOrderBatch_CreatedOn | string | date-time |\r\n| proposedWorkOrderBatchCreatedByUserCode | ProposedWorkOrder->ProposedWorkOrderBatch_CreatedByUser_Code | string | |\r\n", "operationId": "GetProposedWorkOrderCollection", "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 Proposed Work Order collection", "schema": { "$ref": "#/definitions/GetProposedWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderBatch": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Proposed Work Order Batch for the Proposed Work Order.", "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 | ProposedWorkOrderBatch->Id | integer | int64 |\r\n| name | ProposedWorkOrderBatch->Name | string | |\r\n| createdByUserCode | ProposedWorkOrderBatch->CreatedByUser_Code | string | |\r\n", "operationId": "LookupProposedWorkOrderBatch", "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 Proposed Work Order Batch collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderBatchLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderEvent": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Event for the Proposed Work Order.", "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 | Event->Id | integer | int64 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderEvent", "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 Event collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskIntervalType": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Task Interval Type for the Proposed Work Order.", "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 | TaskIntervalType->Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskIntervalType", "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 Task Interval Type collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderIntervalTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderLocation": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Location for the Proposed Work Order.", "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": "LookupProposedWorkOrderLocation", "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/ProposedWorkOrderLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderRegularAsset": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Regular Asset for the Proposed Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderRegularAsset", "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 Regular Asset collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderRegularAssetType": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Regular Asset Type for the Proposed Work Order.", "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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderRegularAssetType", "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 Regular Asset Type collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderSite": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup the Site for the Proposed Work Order.", "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": "LookupProposedWorkOrderSite", "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/ProposedWorkOrderSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification1": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 1 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification1", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification2": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 2 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification2", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification3": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 3 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification3", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification4": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 4 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification4", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification5": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 5 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification5", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification6": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 6 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification6", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification6LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification7": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 7 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification7", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification7LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Lookups/LookupProposedWorkOrderTaskClassification8": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Lookup Proposed Work Order Task Classification 8 for the Proposed Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupProposedWorkOrderTaskClassification8", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/ProposedWorkOrderTaskClassification8LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Batches/{id}": { "delete": { "tags": [ "Proposed Work Order" ], "summary": "Delete an existing Proposed Work Order 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 | ProposedWorkOrderBatch->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": "DeleteProposedWorkOrderBatch", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order Batch Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteProposedWorkOrderBatchResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Proposed Work Order 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/WM/ProposedWorkOrders/Batch/{ids}": { "get": { "tags": [ "Proposed Work Order" ], "summary": "Get a collection of Proposed Work Order 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 | ProposedWorkOrder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ProposedWorkOrder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ProposedWorkOrder->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrder->CreatedOn | string | date-time |\r\n| modifiedByUserId | ProposedWorkOrder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ProposedWorkOrder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ProposedWorkOrder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ProposedWorkOrder->ModifiedOn | string | date-time |\r\n| version | ProposedWorkOrder->Version | integer | int32 |\r\n| permissionTreeId | ProposedWorkOrder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ProposedWorkOrder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ProposedWorkOrder->PermissionTree_Description | string | |\r\n| siteId | ProposedWorkOrder->Site_Id | integer | int64 |\r\n| siteCode | ProposedWorkOrder->Site_Code | string | |\r\n| siteDescription | ProposedWorkOrder->Site_Description | string | |\r\n| id | ProposedWorkOrder->Id | integer | int64 |\r\n| assetId | ProposedWorkOrder->Asset_Id | integer | int64 |\r\n| assetCode | ProposedWorkOrder->Asset_Code | string | |\r\n| assetDescription | ProposedWorkOrder->Asset_Description | string | |\r\n| defaultIntervalId | ProposedWorkOrder->DefaultInterval_Id | integer | int64 |\r\n| defaultIntervalCode | ProposedWorkOrder->DefaultInterval_Code | string | |\r\n| defaultIntervalDescription | ProposedWorkOrder->DefaultInterval_Description | string | |\r\n| defaultIntervalTaskIntervalTypeId | ProposedWorkOrder->DefaultInterval_TaskIntervalType_Id | integer | int64 |\r\n| description | ProposedWorkOrder->Description | string | |\r\n| downtime | ProposedWorkOrder->Downtime | string | duration |\r\n| dueDate | ProposedWorkOrder->DueDate | string | date |\r\n| duration | ProposedWorkOrder->Duration | string | duration |\r\n| eventId | ProposedWorkOrder->Event_Id | integer | int64 |\r\n| eventCode | ProposedWorkOrder->Event_Code | string | |\r\n| eventDescription | ProposedWorkOrder->Event_Description | string | |\r\n| intervalTypeId | ProposedWorkOrder->IntervalType_Id | integer | int64 |\r\n| intervalTypeCode | ProposedWorkOrder->IntervalType_Code | string | |\r\n| intervalTypeDescription | ProposedWorkOrder->IntervalType_Description | string | |\r\n| intervalTypeSchedulingKind | ProposedWorkOrder->IntervalType_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| machineState | ProposedWorkOrder->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| mainScheduledReading | ProposedWorkOrder->MainScheduledReading | number | decimal |\r\n| minStartDate | ProposedWorkOrder->MinStartDate | string | date |\r\n| motionType | ProposedWorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| proposedWorkOrderBatchId | ProposedWorkOrder->ProposedWorkOrderBatch_Id | integer | int64 |\r\n| responsibleSectionId | ProposedWorkOrder->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | ProposedWorkOrder->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | ProposedWorkOrder->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | ProposedWorkOrder->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | ProposedWorkOrder->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceDescription | ProposedWorkOrder->ResponsibleStaffMemberResource_Description | string | |\r\n| responsibleStaffMemberResourceResourceType | ProposedWorkOrder->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleStaffMemberResourceContactDetailDepartment | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailDepartment | string | |\r\n| responsibleStaffMemberResourceContactDetailJobTitle | ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailJobTitle | string | |\r\n| responsibleStaffMemberResourceSiteId | ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Id | integer | int64 |\r\n| responsibleStaffMemberResourceSiteCode | ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Code | string | |\r\n| responsibleStaffMemberResourceSiteDescription | ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Description | string | |\r\n| responsibleTradeId | ProposedWorkOrder->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | ProposedWorkOrder->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | ProposedWorkOrder->ResponsibleTrade_Description | string | |\r\n| status | ProposedWorkOrder->Status | string (Allowed values: [CanGenerateWorkOrder, WorkOrderGenerated, AllTasksSuppressed, ConfigurationIncomplete]) | enum |\r\n| taskClassification1Id | ProposedWorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | ProposedWorkOrder->TaskClassification1_Code | string | |\r\n| taskClassification1Description | ProposedWorkOrder->TaskClassification1_Description | string | |\r\n| taskClassification2Id | ProposedWorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | ProposedWorkOrder->TaskClassification2_Code | string | |\r\n| taskClassification2Description | ProposedWorkOrder->TaskClassification2_Description | string | |\r\n| taskClassification3Id | ProposedWorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | ProposedWorkOrder->TaskClassification3_Code | string | |\r\n| taskClassification3Description | ProposedWorkOrder->TaskClassification3_Description | string | |\r\n| taskClassification4Id | ProposedWorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | ProposedWorkOrder->TaskClassification4_Code | string | |\r\n| taskClassification4Description | ProposedWorkOrder->TaskClassification4_Description | string | |\r\n| taskClassification5Id | ProposedWorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | ProposedWorkOrder->TaskClassification5_Code | string | |\r\n| taskClassification5Description | ProposedWorkOrder->TaskClassification5_Description | string | |\r\n| taskClassification6Id | ProposedWorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | ProposedWorkOrder->TaskClassification6_Code | string | |\r\n| taskClassification6Description | ProposedWorkOrder->TaskClassification6_Description | string | |\r\n| taskClassification7Id | ProposedWorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | ProposedWorkOrder->TaskClassification7_Code | string | |\r\n| taskClassification7Description | ProposedWorkOrder->TaskClassification7_Description | string | |\r\n| taskClassification8Id | ProposedWorkOrder->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | ProposedWorkOrder->TaskClassification8_Code | string | |\r\n| taskClassification8Description | ProposedWorkOrder->TaskClassification8_Description | string | |\r\n| typeOfWorkId | ProposedWorkOrder->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | ProposedWorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | ProposedWorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | ProposedWorkOrder->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | ProposedWorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workOrderId | ProposedWorkOrder->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | ProposedWorkOrder->WorkOrder_Code | string | |\r\n| workOrderDescription | ProposedWorkOrder->WorkOrder_Description | string | |\r\n| workOrderGeneratedOn | ProposedWorkOrder->WorkOrderGeneratedOn | string | date-time |\r\n| workOrderGenerationMessage | ProposedWorkOrder->WorkOrderGenerationMessage | string | |\r\n", "operationId": "BatchGetProposedWorkOrder", "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 Proposed Work Order 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 Proposed Work Order collection", "schema": { "$ref": "#/definitions/BatchGetProposedWorkOrderResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Batches/Batch": { "delete": { "tags": [ "Proposed Work Order" ], "summary": "Delete a collection of existing Proposed Work Order 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 | ProposedWorkOrderBatch->Id | integer | int64 |\r\n| version | ProposedWorkOrderBatch->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": "BatchDeleteProposedWorkOrderBatch", "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/BatchDeleteProposedWorkOrderBatchResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Proposed Work Order 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/WM/ProposedWorkOrders/Batch": { "delete": { "tags": [ "Proposed Work Order" ], "summary": "Delete a collection of existing Proposed Work Order 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 | ProposedWorkOrder->Id | integer | int64 |\r\n| version | ProposedWorkOrder->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": "BatchDeleteProposedWorkOrder", "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/BatchDeleteProposedWorkOrderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Proposed Work Order 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/WM/ProposedWorkOrders/Batches/All": { "delete": { "tags": [ "Proposed Work Order" ], "summary": "Delete All Proposed Work Order Batches.", "operationId": "DeleteAllProposedWorkOrderBatches", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "$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/WM/ProposedWorkOrders/DeleteProposedWorkOrders": { "post": { "tags": [ "Proposed Work Order" ], "summary": "Delete Proposed Work Orders.", "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| deleteAll | DeleteProposedWorkOrdersFilter->DeleteAll | boolean | |\r\n| proposedWorkOrderBatchId | DeleteProposedWorkOrdersFilter->ProposedWorkOrderBatch_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": "DeleteProposedWorkOrders", "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/DeleteProposedWorkOrdersResourceActionRequest" } }, { "$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/WM/ProposedWorkOrders/GenerateProposedWorkOrders": { "post": { "tags": [ "Proposed Work Order" ], "summary": "Generate Proposed Work Orders.", "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| siteId | GenerateProposedWorkOrdersFilter->Site_Id | integer | int64 |\r\n| assetTypeId | GenerateProposedWorkOrdersFilter->AssetType_Id | integer | int64 |\r\n| assetId | GenerateProposedWorkOrdersFilter->Asset_Id | integer | int64 |\r\n| eventId | GenerateProposedWorkOrdersFilter->Event_Id | integer | int64 |\r\n| taskIntervalTypeId | GenerateProposedWorkOrdersFilter->TaskIntervalType_Id | integer | int64 |\r\n| combineMeters | GenerateProposedWorkOrdersFilter->CombineMeters | boolean | |\r\n| combineMonitoringPoints | GenerateProposedWorkOrdersFilter->CombineMonitoringPoints | boolean | |\r\n| combineCalendarAndUsageBasedTasks | GenerateProposedWorkOrdersFilter->CombineCalendarAndUsageBasedTasks | boolean | |\r\n| combineLastDoneLastScheduledTasks | GenerateProposedWorkOrdersFilter->CombineLastDoneLastScheduledTasks | boolean | |\r\n| taskSchedulingMethod | GenerateProposedWorkOrdersFilter->TaskSchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| splitResponsibleTrades | GenerateProposedWorkOrdersFilter->SplitResponsibleTrades | boolean | |\r\n| splitResponsibleSections | GenerateProposedWorkOrdersFilter->SplitResponsibleSections | boolean | |\r\n| splitResponsibleStaff | GenerateProposedWorkOrdersFilter->SplitResponsibleStaff | boolean | |\r\n| splitIntervalType | GenerateProposedWorkOrdersFilter->SplitIntervalType | boolean | |\r\n| splitMotionType | GenerateProposedWorkOrdersFilter->SplitMotionType | boolean | |\r\n| splitMachineState | GenerateProposedWorkOrdersFilter->SplitMachineState | boolean | |\r\n| splitIntervalType | GenerateProposedWorkOrdersFilter->SplitIntervalType | boolean | |\r\n| splitDefaultInterval | GenerateProposedWorkOrdersFilter->SplitDefaultInterval | boolean | |\r\n| splitTypeOfWork | GenerateProposedWorkOrdersFilter->SplitTypeOfWork | boolean | |\r\n| splitTaskClassification1 | GenerateProposedWorkOrdersFilter->SplitTaskClassification1 | boolean | |\r\n| splitTaskClassification2 | GenerateProposedWorkOrdersFilter->SplitTaskClassification2 | boolean | |\r\n| splitTaskClassification3 | GenerateProposedWorkOrdersFilter->SplitTaskClassification3 | boolean | |\r\n| splitTaskClassification4 | GenerateProposedWorkOrdersFilter->SplitTaskClassification4 | boolean | |\r\n| splitTaskClassification5 | GenerateProposedWorkOrdersFilter->SplitTaskClassification5 | boolean | |\r\n| splitTaskClassification6 | GenerateProposedWorkOrdersFilter->SplitTaskClassification6 | boolean | |\r\n| splitTaskClassification7 | GenerateProposedWorkOrdersFilter->SplitTaskClassification7 | boolean | |\r\n| splitTaskClassification8 | GenerateProposedWorkOrdersFilter->SplitTaskClassification8 | boolean | |\r\n| groupingInterval | GenerateProposedWorkOrdersFilter->GroupingInterval | integer | int32 |\r\n| futureRange | GenerateProposedWorkOrdersFilter->FutureRange | integer | int32 |\r\n| groupingIntervalStartDate | GenerateProposedWorkOrdersFilter->GroupingIntervalStartDate | string | date-time |\r\n| locationId | GenerateProposedWorkOrdersFilter->Location_Id | integer | int64 |\r\n| proposedWorkOrdersAsset | GenerateProposedWorkOrdersFilter->ProposedWorkOrdersAsset | string (Allowed values: [NearestRegularAsset, NearestAsset]) | 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\r\n", "operationId": "GenerateProposedWorkOrders", "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/GenerateProposedWorkOrdersResourceActionRequest" } }, { "type": "string", "name": "proposedWorkOrderMessage", "in": "query", "description": "Message to use for the Proposed Work Order Generation background task", "x-nullable": true }, { "$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/WM/ProposedWorkOrders/GenerateWorkOrders": { "post": { "tags": [ "Proposed Work Order" ], "summary": "Generate Work Orders from Proposed Work Orders.", "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| proposedWorkOrderIds | GenerateWorkOrdersFromProposedWorkOrders->ProposedWorkOrderIds | array | array |\r\n| combineResourcesOnSingleWorkOrderTask | GenerateWorkOrdersFromProposedWorkOrders->CombineResourcesOnSingleWorkOrderTask | 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\r\n", "operationId": "GenerateWorkOrders", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/GenerateWorkOrdersFromProposedWorkOrdersResourceActionRequest" } }, { "type": "string", "name": "generateWorkOrderMessage", "in": "query", "description": "Message to use for the Generate Work Order background task", "x-nullable": true }, { "$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/WM/ProposedWorkOrders/Meters/{id}": { "get": { "tags": [ "Proposed Work Order Meter" ], "summary": "Get a Proposed Work Order 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| createdByUserId | ProposedWorkOrderMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ProposedWorkOrderMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ProposedWorkOrderMeter->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrderMeter->CreatedOn | string | date-time |\r\n| modifiedByUserId | ProposedWorkOrderMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ProposedWorkOrderMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ProposedWorkOrderMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ProposedWorkOrderMeter->ModifiedOn | string | date-time |\r\n| version | ProposedWorkOrderMeter->Version | integer | int32 |\r\n| permissionTreeId | ProposedWorkOrderMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ProposedWorkOrderMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ProposedWorkOrderMeter->PermissionTree_Description | string | |\r\n| id | ProposedWorkOrderMeter->Id | integer | int64 |\r\n| meterId | ProposedWorkOrderMeter->Meter_Id | integer | int64 |\r\n| meterCode | ProposedWorkOrderMeter->Meter_Code | string | |\r\n| meterLastReading | ProposedWorkOrderMeter->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | ProposedWorkOrderMeter->Meter_AverageDailyRate | number | decimal |\r\n| meterCumulativeReading | ProposedWorkOrderMeter->Meter_CumulativeReading | number | decimal |\r\n| meterLastReadOn | ProposedWorkOrderMeter->Meter_LastReadOn | string | date-time |\r\n| meterNotes | ProposedWorkOrderMeter->Meter_Notes | string | |\r\n| meterDescription | ProposedWorkOrderMeter->Meter_Description | string | |\r\n| proposedWorkOrderId | ProposedWorkOrderMeter->ProposedWorkOrder_Id | integer | int64 |\r\n| proposedWorkOrderDescription | ProposedWorkOrderMeter->ProposedWorkOrder_Description | string | |\r\n| proposedWorkOrderTaskId | ProposedWorkOrderMeter->ProposedWorkOrderTask_Id | integer | int64 |\r\n| scheduledDate | ProposedWorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | ProposedWorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n", "operationId": "GetProposedWorkOrderMeter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Proposed Work Order Meter", "schema": { "$ref": "#/definitions/GetProposedWorkOrderMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Meters": { "get": { "tags": [ "Proposed Work Order Meter" ], "summary": "Get a collection of Proposed Work Order 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| id | ProposedWorkOrderMeter->Id | integer | int64 |\r\n| proposedWorkOrderDescription | ProposedWorkOrderMeter->ProposedWorkOrder_Description | string | |\r\n| meterCode | ProposedWorkOrderMeter->Meter_Code | string | |\r\n| scheduledDate | ProposedWorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | ProposedWorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n", "operationId": "GetProposedWorkOrderMeterCollection", "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 Proposed Work Order Meter collection", "schema": { "$ref": "#/definitions/GetProposedWorkOrderMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/{id}/Meters": { "get": { "tags": [ "Proposed Work Order Meter" ], "summary": "Get a collection of Proposed Work Order Meter resources for the Proposed Work Order.", "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 | ProposedWorkOrderMeter->Id | integer | int64 |\r\n| version | ProposedWorkOrderMeter->Version | integer | int32 |\r\n| meterId | ProposedWorkOrderMeter->Meter_Id | integer | int64 |\r\n| meterCode | ProposedWorkOrderMeter->Meter_Code | string | |\r\n| scheduledDate | ProposedWorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | ProposedWorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n", "operationId": "GetProposedWorkOrderMeterForProposedWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order 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 Proposed Work Order Meter collection", "schema": { "$ref": "#/definitions/GetProposedWorkOrderMeterForProposedWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Meters/Batch/{ids}": { "get": { "tags": [ "Proposed Work Order Meter" ], "summary": "Get a collection of Proposed Work Order 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| createdByUserId | ProposedWorkOrderMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ProposedWorkOrderMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ProposedWorkOrderMeter->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrderMeter->CreatedOn | string | date-time |\r\n| modifiedByUserId | ProposedWorkOrderMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ProposedWorkOrderMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ProposedWorkOrderMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ProposedWorkOrderMeter->ModifiedOn | string | date-time |\r\n| version | ProposedWorkOrderMeter->Version | integer | int32 |\r\n| permissionTreeId | ProposedWorkOrderMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ProposedWorkOrderMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ProposedWorkOrderMeter->PermissionTree_Description | string | |\r\n| id | ProposedWorkOrderMeter->Id | integer | int64 |\r\n| meterId | ProposedWorkOrderMeter->Meter_Id | integer | int64 |\r\n| meterCode | ProposedWorkOrderMeter->Meter_Code | string | |\r\n| meterLastReading | ProposedWorkOrderMeter->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | ProposedWorkOrderMeter->Meter_AverageDailyRate | number | decimal |\r\n| meterCumulativeReading | ProposedWorkOrderMeter->Meter_CumulativeReading | number | decimal |\r\n| meterLastReadOn | ProposedWorkOrderMeter->Meter_LastReadOn | string | date-time |\r\n| meterNotes | ProposedWorkOrderMeter->Meter_Notes | string | |\r\n| meterDescription | ProposedWorkOrderMeter->Meter_Description | string | |\r\n| proposedWorkOrderId | ProposedWorkOrderMeter->ProposedWorkOrder_Id | integer | int64 |\r\n| proposedWorkOrderDescription | ProposedWorkOrderMeter->ProposedWorkOrder_Description | string | |\r\n| proposedWorkOrderTaskId | ProposedWorkOrderMeter->ProposedWorkOrderTask_Id | integer | int64 |\r\n| scheduledDate | ProposedWorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | ProposedWorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n", "operationId": "BatchGetProposedWorkOrderMeter", "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 Proposed Work Order 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 Proposed Work Order Meter collection", "schema": { "$ref": "#/definitions/BatchGetProposedWorkOrderMeterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Tasks/{id}": { "get": { "tags": [ "Proposed Work Order Task" ], "summary": "Get a Proposed Work Order Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | ProposedWorkOrderTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ProposedWorkOrderTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ProposedWorkOrderTask->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrderTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | ProposedWorkOrderTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ProposedWorkOrderTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ProposedWorkOrderTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ProposedWorkOrderTask->ModifiedOn | string | date-time |\r\n| version | ProposedWorkOrderTask->Version | integer | int32 |\r\n| permissionTreeId | ProposedWorkOrderTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ProposedWorkOrderTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ProposedWorkOrderTask->PermissionTree_Description | string | |\r\n| siteId | ProposedWorkOrderTask->Site_Id | integer | int64 |\r\n| siteCode | ProposedWorkOrderTask->Site_Code | string | |\r\n| siteDescription | ProposedWorkOrderTask->Site_Description | string | |\r\n| id | ProposedWorkOrderTask->Id | integer | int64 |\r\n| alternativeDescription | ProposedWorkOrderTask->AlternativeDescription | string | |\r\n| assetId | ProposedWorkOrderTask->Asset_Id | integer | int64 |\r\n| assetCode | ProposedWorkOrderTask->Asset_Code | string | |\r\n| assetTaskId | ProposedWorkOrderTask->AssetTask_Id | integer | int64 |\r\n| assetTaskCode | ProposedWorkOrderTask->AssetTask_Code | string | |\r\n| assetTaskDescription | ProposedWorkOrderTask->AssetTask_Description | string | |\r\n| assetTaskInspectionType | ProposedWorkOrderTask->AssetTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| defaultIntervalId | ProposedWorkOrderTask->DefaultInterval_Id | integer | int64 |\r\n| defaultIntervalCode | ProposedWorkOrderTask->DefaultInterval_Code | string | |\r\n| defaultIntervalDescription | ProposedWorkOrderTask->DefaultInterval_Description | string | |\r\n| defaultIntervalTaskIntervalTypeId | ProposedWorkOrderTask->DefaultInterval_TaskIntervalType_Id | integer | int64 |\r\n| description | ProposedWorkOrderTask->Description | string | |\r\n| dueDate | ProposedWorkOrderTask->DueDate | string | date |\r\n| dueReading | ProposedWorkOrderTask->DueReading | number | decimal |\r\n| eventId | ProposedWorkOrderTask->Event_Id | integer | int64 |\r\n| eventCode | ProposedWorkOrderTask->Event_Code | string | |\r\n| eventDescription | ProposedWorkOrderTask->Event_Description | string | |\r\n| failedReason | ProposedWorkOrderTask->FailedReason | string | |\r\n| intervalTypeId | ProposedWorkOrderTask->IntervalType_Id | integer | int64 |\r\n| intervalTypeCode | ProposedWorkOrderTask->IntervalType_Code | string | |\r\n| intervalTypeDescription | ProposedWorkOrderTask->IntervalType_Description | string | |\r\n| intervalTypeSchedulingKind | ProposedWorkOrderTask->IntervalType_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isStatutory | ProposedWorkOrderTask->IsStatutory | boolean | |\r\n| isSuppressed | ProposedWorkOrderTask->IsSuppressed | boolean | |\r\n| lastDoneDate | ProposedWorkOrderTask->LastDoneDate | string | date-time |\r\n| lastDoneReading | ProposedWorkOrderTask->LastDoneReading | number | decimal |\r\n| machineState | ProposedWorkOrderTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | ProposedWorkOrderTask->Meter_Id | integer | int64 |\r\n| meterCode | ProposedWorkOrderTask->Meter_Code | string | |\r\n| meterLastReading | ProposedWorkOrderTask->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | ProposedWorkOrderTask->Meter_AverageDailyRate | number | decimal |\r\n| meterCumulativeReading | ProposedWorkOrderTask->Meter_CumulativeReading | number | decimal |\r\n| meterLastReadOn | ProposedWorkOrderTask->Meter_LastReadOn | string | date-time |\r\n| meterNotes | ProposedWorkOrderTask->Meter_Notes | string | |\r\n| meterDescription | ProposedWorkOrderTask->Meter_Description | string | |\r\n| monitoringPointId | ProposedWorkOrderTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | ProposedWorkOrderTask->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | ProposedWorkOrderTask->MonitoringPoint_Description | string | |\r\n| monitoringPointIsCalculated | ProposedWorkOrderTask->MonitoringPoint_IsCalculated | boolean | |\r\n| monitoringPointMonitoringPointTypeId | ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointMonitoringPointTypeCode | ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Code | string | |\r\n| monitoringPointMonitoringPointTypeDescription | ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Description | string | |\r\n| motionType | ProposedWorkOrderTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| proposedWorkOrderId | ProposedWorkOrderTask->ProposedWorkOrder_Id | integer | int64 |\r\n| proposedWorkOrderDescription | ProposedWorkOrderTask->ProposedWorkOrder_Description | string | |\r\n| responsibleSectionId | ProposedWorkOrderTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | ProposedWorkOrderTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | ProposedWorkOrderTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceDescription | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Description | string | |\r\n| responsibleStaffMemberResourceResourceType | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleStaffMemberResourceContactDetailDepartment | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailDepartment | string | |\r\n| responsibleStaffMemberResourceContactDetailJobTitle | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailJobTitle | string | |\r\n| responsibleStaffMemberResourceSiteId | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Id | integer | int64 |\r\n| responsibleStaffMemberResourceSiteCode | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Code | string | |\r\n| responsibleStaffMemberResourceSiteDescription | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Description | string | |\r\n| responsibleTradeId | ProposedWorkOrderTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | ProposedWorkOrderTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | ProposedWorkOrderTask->ResponsibleTrade_Description | string | |\r\n| schedulingKind | ProposedWorkOrderTask->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| schedulingMethod | ProposedWorkOrderTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| suppressedBy | ProposedWorkOrderTask->SuppressedBy | string (Allowed values: [NotSuppressed, SuppressorTask, MachineIsRunning, MachineIsNotRunning, Duplicate, LastDoneTaskOnIncompleteWorkOrder, LastDoneTaskOnPreviousProposedWorkOrder, IncompleteConfiguration]) | enum |\r\n| totalDowntime | ProposedWorkOrderTask->TotalDowntime | string | duration |\r\n| totalDuration | ProposedWorkOrderTask->TotalDuration | string | duration |\r\n| typeOfWorkId | ProposedWorkOrderTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | ProposedWorkOrderTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | ProposedWorkOrderTask->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | ProposedWorkOrderTask->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | ProposedWorkOrderTask->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "GetProposedWorkOrderTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Proposed Work Order Task", "schema": { "$ref": "#/definitions/GetProposedWorkOrderTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Tasks": { "get": { "tags": [ "Proposed Work Order Task" ], "summary": "Get a collection of Proposed Work Order Task resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ProposedWorkOrderTask->Id | integer | int64 |\r\n| proposedWorkOrderId | ProposedWorkOrderTask->ProposedWorkOrder_Id | integer | int64 |\r\n| proposedWorkOrderDescription | ProposedWorkOrderTask->ProposedWorkOrder_Description | string | |\r\n| proposedWorkOrderAssetCode | ProposedWorkOrderTask->ProposedWorkOrder_Asset_Code | string | |\r\n| assetCode | ProposedWorkOrderTask->Asset_Code | string | |\r\n| assetTaskId | ProposedWorkOrderTask->AssetTask_Id | integer | int64 |\r\n| assetTaskCode | ProposedWorkOrderTask->AssetTask_Code | string | |\r\n| assetTaskAssetCode | ProposedWorkOrderTask->AssetTask_Asset_Code | string | |\r\n| failedReason | ProposedWorkOrderTask->FailedReason | string | |\r\n| meterCode | ProposedWorkOrderTask->Meter_Code | string | |\r\n| suppressedBy | ProposedWorkOrderTask->SuppressedBy | string (Allowed values: [NotSuppressed, SuppressorTask, MachineIsRunning, MachineIsNotRunning, Duplicate, LastDoneTaskOnIncompleteWorkOrder, LastDoneTaskOnPreviousProposedWorkOrder, IncompleteConfiguration]) | enum |\r\n| schedulingKind | ProposedWorkOrderTask->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| schedulingMethod | ProposedWorkOrderTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| siteCode | ProposedWorkOrderTask->Site_Code | string | |\r\n| intervalTypeCode | ProposedWorkOrderTask->IntervalType_Code | string | |\r\n| defaultIntervalCode | ProposedWorkOrderTask->DefaultInterval_Code | string | |\r\n| dueDate | ProposedWorkOrderTask->DueDate | string | date |\r\n| lastDoneDate | ProposedWorkOrderTask->LastDoneDate | string | date-time |\r\n| dueReading | ProposedWorkOrderTask->DueReading | number | decimal |\r\n| lastDoneReading | ProposedWorkOrderTask->LastDoneReading | number | decimal |\r\n| createdOn | ProposedWorkOrderTask->CreatedOn | string | date-time |\r\n", "operationId": "GetProposedWorkOrderTaskCollection", "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 Proposed Work Order Task collection", "schema": { "$ref": "#/definitions/GetProposedWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/{id}/Tasks": { "get": { "tags": [ "Proposed Work Order Task" ], "summary": "Get a collection of Proposed Work Order Task resources for the Proposed Work Order.", "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 | ProposedWorkOrderTask->Id | integer | int64 |\r\n| version | ProposedWorkOrderTask->Version | integer | int32 |\r\n| assetCode | ProposedWorkOrderTask->Asset_Code | string | |\r\n| assetTaskId | ProposedWorkOrderTask->AssetTask_Id | integer | int64 |\r\n| assetTaskCode | ProposedWorkOrderTask->AssetTask_Code | string | |\r\n| failedReason | ProposedWorkOrderTask->FailedReason | string | |\r\n| suppressedBy | ProposedWorkOrderTask->SuppressedBy | string (Allowed values: [NotSuppressed, SuppressorTask, MachineIsRunning, MachineIsNotRunning, Duplicate, LastDoneTaskOnIncompleteWorkOrder, LastDoneTaskOnPreviousProposedWorkOrder, IncompleteConfiguration]) | enum |\r\n| schedulingKind | ProposedWorkOrderTask->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| schedulingMethod | ProposedWorkOrderTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| intervalTypeCode | ProposedWorkOrderTask->IntervalType_Code | string | |\r\n| defaultIntervalCode | ProposedWorkOrderTask->DefaultInterval_Code | string | |\r\n| dueDate | ProposedWorkOrderTask->DueDate | string | date |\r\n| dueReading | ProposedWorkOrderTask->DueReading | number | decimal |\r\n", "operationId": "GetProposedWorkOrderTaskForProposedWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Proposed Work Order 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 Proposed Work Order Task collection", "schema": { "$ref": "#/definitions/GetProposedWorkOrderTaskForProposedWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ProposedWorkOrders/Tasks/Batch/{ids}": { "get": { "tags": [ "Proposed Work Order Task" ], "summary": "Get a collection of Proposed Work Order Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | ProposedWorkOrderTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ProposedWorkOrderTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ProposedWorkOrderTask->CreatedByUser_FullName | string | |\r\n| createdOn | ProposedWorkOrderTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | ProposedWorkOrderTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ProposedWorkOrderTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ProposedWorkOrderTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ProposedWorkOrderTask->ModifiedOn | string | date-time |\r\n| version | ProposedWorkOrderTask->Version | integer | int32 |\r\n| permissionTreeId | ProposedWorkOrderTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ProposedWorkOrderTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ProposedWorkOrderTask->PermissionTree_Description | string | |\r\n| siteId | ProposedWorkOrderTask->Site_Id | integer | int64 |\r\n| siteCode | ProposedWorkOrderTask->Site_Code | string | |\r\n| siteDescription | ProposedWorkOrderTask->Site_Description | string | |\r\n| id | ProposedWorkOrderTask->Id | integer | int64 |\r\n| alternativeDescription | ProposedWorkOrderTask->AlternativeDescription | string | |\r\n| assetId | ProposedWorkOrderTask->Asset_Id | integer | int64 |\r\n| assetCode | ProposedWorkOrderTask->Asset_Code | string | |\r\n| assetTaskId | ProposedWorkOrderTask->AssetTask_Id | integer | int64 |\r\n| assetTaskCode | ProposedWorkOrderTask->AssetTask_Code | string | |\r\n| assetTaskDescription | ProposedWorkOrderTask->AssetTask_Description | string | |\r\n| assetTaskInspectionType | ProposedWorkOrderTask->AssetTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| defaultIntervalId | ProposedWorkOrderTask->DefaultInterval_Id | integer | int64 |\r\n| defaultIntervalCode | ProposedWorkOrderTask->DefaultInterval_Code | string | |\r\n| defaultIntervalDescription | ProposedWorkOrderTask->DefaultInterval_Description | string | |\r\n| defaultIntervalTaskIntervalTypeId | ProposedWorkOrderTask->DefaultInterval_TaskIntervalType_Id | integer | int64 |\r\n| description | ProposedWorkOrderTask->Description | string | |\r\n| dueDate | ProposedWorkOrderTask->DueDate | string | date |\r\n| dueReading | ProposedWorkOrderTask->DueReading | number | decimal |\r\n| eventId | ProposedWorkOrderTask->Event_Id | integer | int64 |\r\n| eventCode | ProposedWorkOrderTask->Event_Code | string | |\r\n| eventDescription | ProposedWorkOrderTask->Event_Description | string | |\r\n| failedReason | ProposedWorkOrderTask->FailedReason | string | |\r\n| intervalTypeId | ProposedWorkOrderTask->IntervalType_Id | integer | int64 |\r\n| intervalTypeCode | ProposedWorkOrderTask->IntervalType_Code | string | |\r\n| intervalTypeDescription | ProposedWorkOrderTask->IntervalType_Description | string | |\r\n| intervalTypeSchedulingKind | ProposedWorkOrderTask->IntervalType_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isStatutory | ProposedWorkOrderTask->IsStatutory | boolean | |\r\n| isSuppressed | ProposedWorkOrderTask->IsSuppressed | boolean | |\r\n| lastDoneDate | ProposedWorkOrderTask->LastDoneDate | string | date-time |\r\n| lastDoneReading | ProposedWorkOrderTask->LastDoneReading | number | decimal |\r\n| machineState | ProposedWorkOrderTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | ProposedWorkOrderTask->Meter_Id | integer | int64 |\r\n| meterCode | ProposedWorkOrderTask->Meter_Code | string | |\r\n| meterLastReading | ProposedWorkOrderTask->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | ProposedWorkOrderTask->Meter_AverageDailyRate | number | decimal |\r\n| meterCumulativeReading | ProposedWorkOrderTask->Meter_CumulativeReading | number | decimal |\r\n| meterLastReadOn | ProposedWorkOrderTask->Meter_LastReadOn | string | date-time |\r\n| meterNotes | ProposedWorkOrderTask->Meter_Notes | string | |\r\n| meterDescription | ProposedWorkOrderTask->Meter_Description | string | |\r\n| monitoringPointId | ProposedWorkOrderTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | ProposedWorkOrderTask->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | ProposedWorkOrderTask->MonitoringPoint_Description | string | |\r\n| monitoringPointIsCalculated | ProposedWorkOrderTask->MonitoringPoint_IsCalculated | boolean | |\r\n| monitoringPointMonitoringPointTypeId | ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointMonitoringPointTypeCode | ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Code | string | |\r\n| monitoringPointMonitoringPointTypeDescription | ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Description | string | |\r\n| motionType | ProposedWorkOrderTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| proposedWorkOrderId | ProposedWorkOrderTask->ProposedWorkOrder_Id | integer | int64 |\r\n| proposedWorkOrderDescription | ProposedWorkOrderTask->ProposedWorkOrder_Description | string | |\r\n| responsibleSectionId | ProposedWorkOrderTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | ProposedWorkOrderTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | ProposedWorkOrderTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceDescription | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Description | string | |\r\n| responsibleStaffMemberResourceResourceType | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleStaffMemberResourceContactDetailDepartment | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailDepartment | string | |\r\n| responsibleStaffMemberResourceContactDetailJobTitle | ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailJobTitle | string | |\r\n| responsibleStaffMemberResourceSiteId | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Id | integer | int64 |\r\n| responsibleStaffMemberResourceSiteCode | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Code | string | |\r\n| responsibleStaffMemberResourceSiteDescription | ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Description | string | |\r\n| responsibleTradeId | ProposedWorkOrderTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | ProposedWorkOrderTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | ProposedWorkOrderTask->ResponsibleTrade_Description | string | |\r\n| schedulingKind | ProposedWorkOrderTask->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| schedulingMethod | ProposedWorkOrderTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| suppressedBy | ProposedWorkOrderTask->SuppressedBy | string (Allowed values: [NotSuppressed, SuppressorTask, MachineIsRunning, MachineIsNotRunning, Duplicate, LastDoneTaskOnIncompleteWorkOrder, LastDoneTaskOnPreviousProposedWorkOrder, IncompleteConfiguration]) | enum |\r\n| totalDowntime | ProposedWorkOrderTask->TotalDowntime | string | duration |\r\n| totalDuration | ProposedWorkOrderTask->TotalDuration | string | duration |\r\n| typeOfWorkId | ProposedWorkOrderTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | ProposedWorkOrderTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | ProposedWorkOrderTask->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | ProposedWorkOrderTask->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | ProposedWorkOrderTask->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "BatchGetProposedWorkOrderTask", "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 Proposed Work Order Task 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 Proposed Work Order Task collection", "schema": { "$ref": "#/definitions/BatchGetProposedWorkOrderTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/{id}": { "get": { "tags": [ "Service Level Agreement" ], "summary": "Get a Service Level Agreement 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 | ServiceLevelAgreement->Code | string | |\r\n| isActive | ServiceLevelAgreement->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreement->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreement->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreement->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreement->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreement->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreement->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreement->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreement->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreement->Id | integer | int64 |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| isInitialised | ServiceLevelAgreement->IsInitialised | boolean | |\r\n| isTemplate | ServiceLevelAgreement->IsTemplate | boolean | |\r\n| matchCriteria | ServiceLevelAgreement->MatchCriteria | string | |\r\n| measureFromAssignedDate | ServiceLevelAgreement->MeasureFromAssignedDate | boolean | |\r\n| notes | ServiceLevelAgreement->Notes | string | |\r\n| resetMeasurementOnReAssignDate | ServiceLevelAgreement->ResetMeasurementOnReAssignDate | boolean | |\r\n| sequenceNumber | ServiceLevelAgreement->SequenceNumber | integer | int32 |\r\n| serviceLevelAgreementClassificationId | ServiceLevelAgreement->ServiceLevelAgreementClassification_Id | integer | int64 |\r\n| serviceLevelAgreementClassificationCode | ServiceLevelAgreement->ServiceLevelAgreementClassification_Code | string | |\r\n| serviceLevelAgreementClassificationDescription | ServiceLevelAgreement->ServiceLevelAgreementClassification_Description | string | |\r\n| templateServiceLevelAgreementId | ServiceLevelAgreement->TemplateServiceLevelAgreement_Id | integer | int64 |\r\n| templateServiceLevelAgreementCode | ServiceLevelAgreement->TemplateServiceLevelAgreement_Code | string | |\r\n| templateServiceLevelAgreementDescription | ServiceLevelAgreement->TemplateServiceLevelAgreement_Description | string | |\r\n| workOrderEndStatusId | ServiceLevelAgreement->WorkOrderEndStatus_Id | integer | int64 |\r\n| workOrderEndStatusCode | ServiceLevelAgreement->WorkOrderEndStatus_Code | string | |\r\n| workOrderEndStatusDescription | ServiceLevelAgreement->WorkOrderEndStatus_Description | string | |\r\n| workOrderEndStatusBaseStatus | ServiceLevelAgreement->WorkOrderEndStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStartStatusId | ServiceLevelAgreement->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderStartStatusCode | ServiceLevelAgreement->WorkOrderStartStatus_Code | string | |\r\n| workOrderStartStatusDescription | ServiceLevelAgreement->WorkOrderStartStatus_Description | string | |\r\n| workOrderStartStatusBaseStatus | ServiceLevelAgreement->WorkOrderStartStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "GetServiceLevelAgreement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Service Level Agreement", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Service Level Agreement" ], "summary": "Update an existing Service Level Agreement 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 | ServiceLevelAgreement->Version | integer | int32 |\r\n| code | ServiceLevelAgreement->Code | string | |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| matchCriteria | ServiceLevelAgreement->MatchCriteria | string | |\r\n| measureFromAssignedDate | ServiceLevelAgreement->MeasureFromAssignedDate | boolean | |\r\n| resetMeasurementOnReAssignDate | ServiceLevelAgreement->ResetMeasurementOnReAssignDate | boolean | |\r\n| sequenceNumber | ServiceLevelAgreement->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreement->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| measureFromAssignedDate | Nullable | False | |\r\n| resetMeasurementOnReAssignDate | Nullable | False | |\r\n\r\n", "operationId": "UpdateServiceLevelAgreement", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateServiceLevelAgreementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement 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": [ "Service Level Agreement" ], "summary": "Delete an existing Service Level Agreement 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 | ServiceLevelAgreement->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": "DeleteServiceLevelAgreement", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteServiceLevelAgreementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement 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/WM/ServiceLevelAgreements": { "get": { "tags": [ "Service Level Agreement" ], "summary": "Get a collection of Service Level Agreement 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 | ServiceLevelAgreement->Version | integer | int32 |\r\n| id | ServiceLevelAgreement->Id | integer | int64 |\r\n| code | ServiceLevelAgreement->Code | string | |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| isInitialised | ServiceLevelAgreement->IsInitialised | boolean | |\r\n| serviceLevelAgreementClassificationCode | ServiceLevelAgreement->ServiceLevelAgreementClassification_Code | string | |\r\n| permissionTreeCode | ServiceLevelAgreement->PermissionTree_Code | string | |\r\n| notes | ServiceLevelAgreement->Notes | string | |\r\n", "operationId": "GetServiceLevelAgreementCollection", "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 Service Level Agreement collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Service Level Agreement" ], "summary": "Create a new Service Level Agreement 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 | ServiceLevelAgreement->PermissionTree_Id | integer | int64 |\r\n| code | ServiceLevelAgreement->Code | string | |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| serviceLevelAgreementClassificationId | ServiceLevelAgreement->ServiceLevelAgreementClassification_Id | integer | int64 |\r\n| matchCriteria | ServiceLevelAgreement->MatchCriteria | string | |\r\n| measureFromAssignedDate | ServiceLevelAgreement->MeasureFromAssignedDate | boolean | |\r\n| resetMeasurementOnReAssignDate | ServiceLevelAgreement->ResetMeasurementOnReAssignDate | boolean | |\r\n| sequenceNumber | ServiceLevelAgreement->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreement->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| serviceLevelAgreementClassificationId | Required | True | |\r\n| serviceLevelAgreementClassificationId | Nullable | False | |\r\n| measureFromAssignedDate | Nullable | False | |\r\n| resetMeasurementOnReAssignDate | Nullable | False | |\r\n\r\n", "operationId": "CreateServiceLevelAgreement", "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/CreateServiceLevelAgreementResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Lookups/LookupServiceLevelAgreementChangePermissionTree": { "get": { "tags": [ "Service Level Agreement" ], "summary": "Lookup the permission set for changing the Service Level Agreement.", "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": "LookupServiceLevelAgreementChangePermissionTree", "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/ServiceLevelAgreementChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Lookups/LookupServiceLevelAgreementInsertPermissionTree": { "get": { "tags": [ "Service Level Agreement" ], "summary": "Lookup the permission set for creating the Service Level Agreement.", "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": "LookupServiceLevelAgreementInsertPermissionTree", "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/ServiceLevelAgreementInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Lookups/LookupServiceLevelAgreementServiceLevelAgreementClassification": { "get": { "tags": [ "Service Level Agreement" ], "summary": "Lookup the Service Level Agreement Classification for the Service Level Agreement.", "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 | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| code | ServiceLevelAgreementClassification->Code | string | |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementServiceLevelAgreementClassification", "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 Service Level Agreement Classification collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementServiceLevelAgreementClassificationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Batch/{ids}": { "get": { "tags": [ "Service Level Agreement" ], "summary": "Get a collection of Service Level Agreement 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 | ServiceLevelAgreement->Code | string | |\r\n| isActive | ServiceLevelAgreement->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreement->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreement->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreement->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreement->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreement->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreement->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreement->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreement->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreement->Id | integer | int64 |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| isInitialised | ServiceLevelAgreement->IsInitialised | boolean | |\r\n| isTemplate | ServiceLevelAgreement->IsTemplate | boolean | |\r\n| matchCriteria | ServiceLevelAgreement->MatchCriteria | string | |\r\n| measureFromAssignedDate | ServiceLevelAgreement->MeasureFromAssignedDate | boolean | |\r\n| notes | ServiceLevelAgreement->Notes | string | |\r\n| resetMeasurementOnReAssignDate | ServiceLevelAgreement->ResetMeasurementOnReAssignDate | boolean | |\r\n| sequenceNumber | ServiceLevelAgreement->SequenceNumber | integer | int32 |\r\n| serviceLevelAgreementClassificationId | ServiceLevelAgreement->ServiceLevelAgreementClassification_Id | integer | int64 |\r\n| serviceLevelAgreementClassificationCode | ServiceLevelAgreement->ServiceLevelAgreementClassification_Code | string | |\r\n| serviceLevelAgreementClassificationDescription | ServiceLevelAgreement->ServiceLevelAgreementClassification_Description | string | |\r\n| templateServiceLevelAgreementId | ServiceLevelAgreement->TemplateServiceLevelAgreement_Id | integer | int64 |\r\n| templateServiceLevelAgreementCode | ServiceLevelAgreement->TemplateServiceLevelAgreement_Code | string | |\r\n| templateServiceLevelAgreementDescription | ServiceLevelAgreement->TemplateServiceLevelAgreement_Description | string | |\r\n| workOrderEndStatusId | ServiceLevelAgreement->WorkOrderEndStatus_Id | integer | int64 |\r\n| workOrderEndStatusCode | ServiceLevelAgreement->WorkOrderEndStatus_Code | string | |\r\n| workOrderEndStatusDescription | ServiceLevelAgreement->WorkOrderEndStatus_Description | string | |\r\n| workOrderEndStatusBaseStatus | ServiceLevelAgreement->WorkOrderEndStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStartStatusId | ServiceLevelAgreement->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderStartStatusCode | ServiceLevelAgreement->WorkOrderStartStatus_Code | string | |\r\n| workOrderStartStatusDescription | ServiceLevelAgreement->WorkOrderStartStatus_Description | string | |\r\n| workOrderStartStatusBaseStatus | ServiceLevelAgreement->WorkOrderStartStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "BatchGetServiceLevelAgreement", "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 Service Level Agreement 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 Service Level Agreement collection", "schema": { "$ref": "#/definitions/BatchGetServiceLevelAgreementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Batch": { "post": { "tags": [ "Service Level Agreement" ], "summary": "Create a new collection of Service Level Agreement 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 | ServiceLevelAgreement->PermissionTree_Id | integer | int64 |\r\n| code | ServiceLevelAgreement->Code | string | |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| serviceLevelAgreementClassificationId | ServiceLevelAgreement->ServiceLevelAgreementClassification_Id | integer | int64 |\r\n| matchCriteria | ServiceLevelAgreement->MatchCriteria | string | |\r\n| measureFromAssignedDate | ServiceLevelAgreement->MeasureFromAssignedDate | boolean | |\r\n| resetMeasurementOnReAssignDate | ServiceLevelAgreement->ResetMeasurementOnReAssignDate | boolean | |\r\n| sequenceNumber | ServiceLevelAgreement->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreement->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| serviceLevelAgreementClassificationId | Required | True | |\r\n| serviceLevelAgreementClassificationId | Nullable | False | |\r\n| measureFromAssignedDate | Nullable | False | |\r\n| resetMeasurementOnReAssignDate | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateServiceLevelAgreement", "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/BatchCreateServiceLevelAgreementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Service Level Agreement 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": [ "Service Level Agreement" ], "summary": "Update a collection of existing Service Level Agreement 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 | ServiceLevelAgreement->Id | integer | int64 |\r\n| version | ServiceLevelAgreement->Version | integer | int32 |\r\n| code | ServiceLevelAgreement->Code | string | |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n| matchCriteria | ServiceLevelAgreement->MatchCriteria | string | |\r\n| measureFromAssignedDate | ServiceLevelAgreement->MeasureFromAssignedDate | boolean | |\r\n| resetMeasurementOnReAssignDate | ServiceLevelAgreement->ResetMeasurementOnReAssignDate | boolean | |\r\n| sequenceNumber | ServiceLevelAgreement->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreement->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| measureFromAssignedDate | Nullable | False | |\r\n| resetMeasurementOnReAssignDate | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateServiceLevelAgreement", "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/BatchUpdateServiceLevelAgreementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement 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": [ "Service Level Agreement" ], "summary": "Delete a collection of existing Service Level Agreement 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 | ServiceLevelAgreement->Id | integer | int64 |\r\n| version | ServiceLevelAgreement->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": "BatchDeleteServiceLevelAgreement", "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/BatchDeleteServiceLevelAgreementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement 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/WM/ServiceLevelAgreements/{id}/Active": { "patch": { "tags": [ "Service Level Agreement" ], "summary": "Change the IsActive status for an existing Service Level Agreement 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 | ServiceLevelAgreement->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreement->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": "ChangeServiceLevelAgreementIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/{id}/Initialised": { "patch": { "tags": [ "Service Level Agreement" ], "summary": "Change Service Level Agreement IsInitialised", "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 | ChangeServiceLevelAgreementIsInitialised->Version | integer | int32 |\r\n| isInitialised | ChangeServiceLevelAgreementIsInitialised->IsInitialised | 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| isInitialised | Required | True | |\r\n| isInitialised | Nullable | False | |\r\n\r\n", "operationId": "ChangeServiceLevelAgreementIsInitialised", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementIsInitialisedResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/{id}/PermissionTree": { "patch": { "tags": [ "Service Level Agreement" ], "summary": "Change the PermissionTree for an existing Service Level Agreement 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 | ServiceLevelAgreement->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreement->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": "ChangeServiceLevelAgreementPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Sync/Pull": { "post": { "tags": [ "Service Level Agreement" ], "summary": "Pull Service Level Agreement Template Updates", "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| serviceLevelAgreementIds | PullServiceLevelAgreementTemplateUpdates->ServiceLevelAgreementIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "PullServiceLevelAgreementTemplateUpdates", "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/PullServiceLevelAgreementTemplateUpdatesResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Sync/Push": { "post": { "tags": [ "Service Level Agreement" ], "summary": "Push Service Level Agreement Template Updates", "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| serviceLevelAgreementIds | PushServiceLevelAgreementTemplateUpdates->ServiceLevelAgreementIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "PushServiceLevelAgreementTemplateUpdates", "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/PushServiceLevelAgreementTemplateUpdatesResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Batch/Active": { "patch": { "tags": [ "Service Level Agreement" ], "summary": "Change the IsActive status for a collection of existing Service Level Agreement 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 | ServiceLevelAgreement->Id | integer | int64 |\r\n| version | ServiceLevelAgreement->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreement->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": "BatchChangeServiceLevelAgreementIsActive", "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/BatchChangeServiceLevelAgreementIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Batch/PermissionTree": { "patch": { "tags": [ "Service Level Agreement" ], "summary": "Change the PermissionTree status for a collection of existing Service Level Agreement 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 | ServiceLevelAgreement->Id | integer | int64 |\r\n| version | ServiceLevelAgreement->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreement->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": "BatchChangeServiceLevelAgreementPermissionTree", "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/BatchChangeServiceLevelAgreementPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreementClassifications/{id}": { "get": { "tags": [ "Service Level Agreement Classification" ], "summary": "Get a Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Code | string | |\r\n| isActive | ServiceLevelAgreementClassification->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementClassification->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementClassification->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementClassification->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementClassification->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementClassification->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementClassification->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementClassification->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementClassification->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementClassification->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementClassification->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementClassification->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| notes | ServiceLevelAgreementClassification->Notes | string | |\r\n| sequenceNumber | ServiceLevelAgreementClassification->SequenceNumber | integer | int32 |\r\n", "operationId": "GetServiceLevelAgreementClassification", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Classification Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Service Level Agreement Classification", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementClassificationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Service Level Agreement Classification" ], "summary": "Update an existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| code | ServiceLevelAgreementClassification->Code | string | |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| sequenceNumber | ServiceLevelAgreementClassification->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementClassification->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| matchType | Nullable | False | |\r\n\r\n", "operationId": "UpdateServiceLevelAgreementClassification", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Classification Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateServiceLevelAgreementClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Classification 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": [ "Service Level Agreement Classification" ], "summary": "Delete an existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->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": "DeleteServiceLevelAgreementClassification", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Classification Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteServiceLevelAgreementClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Classification 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/WM/ServiceLevelAgreementClassifications": { "get": { "tags": [ "Service Level Agreement Classification" ], "summary": "Get a collection of Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| id | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| code | ServiceLevelAgreementClassification->Code | string | |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| permissionTreeCode | ServiceLevelAgreementClassification->PermissionTree_Code | string | |\r\n| notes | ServiceLevelAgreementClassification->Notes | string | |\r\n", "operationId": "GetServiceLevelAgreementClassificationCollection", "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 Service Level Agreement Classification collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementClassificationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Service Level Agreement Classification" ], "summary": "Create a new Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->PermissionTree_Id | integer | int64 |\r\n| code | ServiceLevelAgreementClassification->Code | string | |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| sequenceNumber | ServiceLevelAgreementClassification->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementClassification->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| matchType | Required | True | |\r\n| matchType | Nullable | False | |\r\n\r\n", "operationId": "CreateServiceLevelAgreementClassification", "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/CreateServiceLevelAgreementClassificationResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreementClassifications/Lookups/LookupServiceLevelAgreementClassificationChangePermissionTree": { "get": { "tags": [ "Service Level Agreement Classification" ], "summary": "Lookup the permission set for changing the Service Level Agreement Classification.", "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": "LookupServiceLevelAgreementClassificationChangePermissionTree", "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/ServiceLevelAgreementClassificationChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreementClassifications/Lookups/LookupServiceLevelAgreementClassificationInsertPermissionTree": { "get": { "tags": [ "Service Level Agreement Classification" ], "summary": "Lookup the permission set for creating the Service Level Agreement Classification.", "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": "LookupServiceLevelAgreementClassificationInsertPermissionTree", "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/ServiceLevelAgreementClassificationInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreementClassifications/Batch/{ids}": { "get": { "tags": [ "Service Level Agreement Classification" ], "summary": "Get a collection of Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Code | string | |\r\n| isActive | ServiceLevelAgreementClassification->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementClassification->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementClassification->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementClassification->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementClassification->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementClassification->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementClassification->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementClassification->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementClassification->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementClassification->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementClassification->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementClassification->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| notes | ServiceLevelAgreementClassification->Notes | string | |\r\n| sequenceNumber | ServiceLevelAgreementClassification->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetServiceLevelAgreementClassification", "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 Service Level Agreement Classification 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 Service Level Agreement Classification collection", "schema": { "$ref": "#/definitions/BatchGetServiceLevelAgreementClassificationResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreementClassifications/Batch": { "post": { "tags": [ "Service Level Agreement Classification" ], "summary": "Create a new collection of Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->PermissionTree_Id | integer | int64 |\r\n| code | ServiceLevelAgreementClassification->Code | string | |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| sequenceNumber | ServiceLevelAgreementClassification->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementClassification->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| matchType | Required | True | |\r\n| matchType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateServiceLevelAgreementClassification", "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/BatchCreateServiceLevelAgreementClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Service Level Agreement Classification 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": [ "Service Level Agreement Classification" ], "summary": "Update a collection of existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| version | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| code | ServiceLevelAgreementClassification->Code | string | |\r\n| description | ServiceLevelAgreementClassification->Description | string | |\r\n| matchType | ServiceLevelAgreementClassification->MatchType | string (Allowed values: [Single, Multiple]) | enum |\r\n| sequenceNumber | ServiceLevelAgreementClassification->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementClassification->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| matchType | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateServiceLevelAgreementClassification", "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/BatchUpdateServiceLevelAgreementClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Classification 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": [ "Service Level Agreement Classification" ], "summary": "Delete a collection of existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| version | ServiceLevelAgreementClassification->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": "BatchDeleteServiceLevelAgreementClassification", "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/BatchDeleteServiceLevelAgreementClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Classification 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/WM/ServiceLevelAgreementClassifications/{id}/Active": { "patch": { "tags": [ "Service Level Agreement Classification" ], "summary": "Change the IsActive status for an existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementClassification->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": "ChangeServiceLevelAgreementClassificationIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Classification Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreementClassifications/{id}/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Classification" ], "summary": "Change the PermissionTree for an existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementClassification->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": "ChangeServiceLevelAgreementClassificationPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Classification Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreementClassifications/Batch/Active": { "patch": { "tags": [ "Service Level Agreement Classification" ], "summary": "Change the IsActive status for a collection of existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| version | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementClassification->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": "BatchChangeServiceLevelAgreementClassificationIsActive", "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/BatchChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreementClassifications/Batch/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Classification" ], "summary": "Change the PermissionTree status for a collection of existing Service Level Agreement Classification 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 | ServiceLevelAgreementClassification->Id | integer | int64 |\r\n| version | ServiceLevelAgreementClassification->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementClassification->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": "BatchChangeServiceLevelAgreementClassificationPermissionTree", "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/BatchChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/{id}": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Get a Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Code | string | |\r\n| isActive | ServiceLevelAgreementMeasure->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementMeasure->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementMeasure->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementMeasure->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementMeasure->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementMeasure->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementMeasure->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementMeasure->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementMeasure->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasure->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementMeasure->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementMeasure->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| calendarId | ServiceLevelAgreementMeasure->Calendar_Id | integer | int64 |\r\n| calendarCode | ServiceLevelAgreementMeasure->Calendar_Code | string | |\r\n| calendarDescription | ServiceLevelAgreementMeasure->Calendar_Description | string | |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| isTemplate | ServiceLevelAgreementMeasure->IsTemplate | boolean | |\r\n| notes | ServiceLevelAgreementMeasure->Notes | string | |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| serviceLevelAgreementId | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementDescription | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Description | string | |\r\n| templateServiceLevelAgreementMeasureId | ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| templateServiceLevelAgreementMeasureCode | ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Code | string | |\r\n| templateServiceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Description | string | |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| workOrderEndStatusCode | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code | string | |\r\n| workOrderEndStatusDescription | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Description | string | |\r\n| workOrderEndStatusBaseStatus | ServiceLevelAgreementMeasure->WorkOrderEndStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderStartStatusCode | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code | string | |\r\n| workOrderStartStatusDescription | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Description | string | |\r\n| workOrderStartStatusBaseStatus | ServiceLevelAgreementMeasure->WorkOrderStartStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "GetServiceLevelAgreementMeasure", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Service Level Agreement Measure", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Service Level Agreement Measure" ], "summary": "Update an existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasure->Code | string | |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| calendarId | ServiceLevelAgreementMeasure->Calendar_Id | integer | int64 |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasure->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| isMain | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| workOrderStartStatusId | Nullable | False | |\r\n| workOrderEndStatusId | Nullable | False | |\r\n| duration | Nullable | False | |\r\n| duration | Min Value | > 00:00:00| |\r\n| calendarType | Nullable | False | |\r\n| calendarId | Nullable | False | ServiceLevelAgreementMeasure->CalendarType eq 'Custom' |\r\n| calendarId | Nullable | True | ServiceLevelAgreementMeasure->CalendarType ne 'Custom' |\r\n\r\n", "operationId": "UpdateServiceLevelAgreementMeasure", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateServiceLevelAgreementMeasureResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure 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": [ "Service Level Agreement Measure" ], "summary": "Delete an existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->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": "DeleteServiceLevelAgreementMeasure", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteServiceLevelAgreementMeasureResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure 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/WM/ServiceLevelAgreements/Measures": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Get a collection of Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| id | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasure->Code | string | |\r\n| serviceLevelAgreementCode | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code | string | |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| workOrderStartStatusCode | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code | string | |\r\n| workOrderEndStatusCode | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code | string | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n", "operationId": "GetServiceLevelAgreementMeasureCollection", "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 Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Service Level Agreement Measure" ], "summary": "Create a new Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Code | string | |\r\n| permissionTreeId | ServiceLevelAgreementMeasure->PermissionTree_Id | integer | int64 |\r\n| serviceLevelAgreementId | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id | integer | int64 |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| calendarId | ServiceLevelAgreementMeasure->Calendar_Id | integer | int64 |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasure->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| serviceLevelAgreementId | Required | True | |\r\n| serviceLevelAgreementId | Nullable | False | |\r\n| isMain | Required | True | |\r\n| isMain | Nullable | False | |\r\n| workOrderStartStatusId | Required | True | |\r\n| workOrderStartStatusId | Nullable | False | |\r\n| workOrderEndStatusId | Required | True | |\r\n| workOrderEndStatusId | Nullable | False | |\r\n| calendarType | Required | True | |\r\n| calendarType | Nullable | False | |\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| duration | Nullable | False | |\r\n| duration | Min Value | > 00:00:00| |\r\n| calendarId | Nullable | False | ServiceLevelAgreementMeasure->CalendarType eq 'Custom' |\r\n| calendarId | Nullable | True | ServiceLevelAgreementMeasure->CalendarType ne 'Custom' |\r\n\r\n", "operationId": "CreateServiceLevelAgreementMeasure", "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/CreateServiceLevelAgreementMeasureResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/{serviceLevelAgreementId}/Measures": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Get a collection of Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| id | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasure->Code | string | |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| serviceLevelAgreementId | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code | string | |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderStartStatusCode | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code | string | |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| workOrderEndStatusCode | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code | string | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n", "operationId": "GetServiceLevelAgreementMeasureForServiceLevelAgreementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "serviceLevelAgreementId", "in": "path", "required": true, "description": "Service Level Agreement 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 Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureForServiceLevelAgreementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Lookups/LookupServiceLevelAgreementMeasureCalendar": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Lookup the Calendar for the Service Level Agreement Measure.", "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 | Calendar->Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureCalendar", "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 Calendar collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureCalendarLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Lookups/LookupServiceLevelAgreementMeasureChangePermissionTree": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Lookup the permission set for changing the Service Level Agreement Measure.", "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": "LookupServiceLevelAgreementMeasureChangePermissionTree", "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/ServiceLevelAgreementMeasureChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Lookups/LookupServiceLevelAgreementMeasureInsertPermissionTree": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Lookup the permission set for creating the Service Level Agreement Measure.", "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": "LookupServiceLevelAgreementMeasureInsertPermissionTree", "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/ServiceLevelAgreementMeasureInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Lookups/LookupServiceLevelAgreementMeasureServiceLevelAgreement": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Lookup the Service Level Agreement for the Service Level Agreement Measure.", "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 | ServiceLevelAgreement->Id | integer | int64 |\r\n| code | ServiceLevelAgreement->Code | string | |\r\n| description | ServiceLevelAgreement->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureServiceLevelAgreement", "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 Service Level Agreement collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureServiceLevelAgreementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Lookups/LookupServiceLevelAgreementMeasureWorkOrderEndStatus": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Lookup the Work Order Status for the Service Level Agreement Measure.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureWorkOrderEndStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureWorkOrderEndStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Lookups/LookupServiceLevelAgreementMeasureWorkOrderStartStatus": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Lookup the Work Order Status for the Service Level Agreement Measure.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureWorkOrderStartStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureWorkOrderStartStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Batch/{ids}": { "get": { "tags": [ "Service Level Agreement Measure" ], "summary": "Get a collection of Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Code | string | |\r\n| isActive | ServiceLevelAgreementMeasure->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementMeasure->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementMeasure->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementMeasure->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementMeasure->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementMeasure->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementMeasure->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementMeasure->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementMeasure->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasure->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementMeasure->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementMeasure->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| calendarId | ServiceLevelAgreementMeasure->Calendar_Id | integer | int64 |\r\n| calendarCode | ServiceLevelAgreementMeasure->Calendar_Code | string | |\r\n| calendarDescription | ServiceLevelAgreementMeasure->Calendar_Description | string | |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| isTemplate | ServiceLevelAgreementMeasure->IsTemplate | boolean | |\r\n| notes | ServiceLevelAgreementMeasure->Notes | string | |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| serviceLevelAgreementId | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementDescription | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Description | string | |\r\n| templateServiceLevelAgreementMeasureId | ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| templateServiceLevelAgreementMeasureCode | ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Code | string | |\r\n| templateServiceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Description | string | |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| workOrderEndStatusCode | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code | string | |\r\n| workOrderEndStatusDescription | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Description | string | |\r\n| workOrderEndStatusBaseStatus | ServiceLevelAgreementMeasure->WorkOrderEndStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderStartStatusCode | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code | string | |\r\n| workOrderStartStatusDescription | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Description | string | |\r\n| workOrderStartStatusBaseStatus | ServiceLevelAgreementMeasure->WorkOrderStartStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "BatchGetServiceLevelAgreementMeasure", "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 Service Level Agreement Measure 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 Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/BatchGetServiceLevelAgreementMeasureResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Batch": { "post": { "tags": [ "Service Level Agreement Measure" ], "summary": "Create a new collection of Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Code | string | |\r\n| permissionTreeId | ServiceLevelAgreementMeasure->PermissionTree_Id | integer | int64 |\r\n| serviceLevelAgreementId | ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id | integer | int64 |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| calendarId | ServiceLevelAgreementMeasure->Calendar_Id | integer | int64 |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasure->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| serviceLevelAgreementId | Required | True | |\r\n| serviceLevelAgreementId | Nullable | False | |\r\n| isMain | Required | True | |\r\n| isMain | Nullable | False | |\r\n| workOrderStartStatusId | Required | True | |\r\n| workOrderStartStatusId | Nullable | False | |\r\n| workOrderEndStatusId | Required | True | |\r\n| workOrderEndStatusId | Nullable | False | |\r\n| calendarType | Required | True | |\r\n| calendarType | Nullable | False | |\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| duration | Nullable | False | |\r\n| duration | Min Value | > 00:00:00| |\r\n| calendarId | Nullable | False | ServiceLevelAgreementMeasure->CalendarType eq 'Custom' |\r\n| calendarId | Nullable | True | ServiceLevelAgreementMeasure->CalendarType ne 'Custom' |\r\n\r\n", "operationId": "BatchCreateServiceLevelAgreementMeasure", "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/BatchCreateServiceLevelAgreementMeasureResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure 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": [ "Service Level Agreement Measure" ], "summary": "Update a collection of existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasure->Code | string | |\r\n| isMain | ServiceLevelAgreementMeasure->IsMain | boolean | |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n| workOrderStartStatusId | ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id | integer | int64 |\r\n| workOrderEndStatusId | ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id | integer | int64 |\r\n| duration | ServiceLevelAgreementMeasure->Duration | string | duration |\r\n| calendarType | ServiceLevelAgreementMeasure->CalendarType | string (Allowed values: [None, Custom, WorkOrderAsset]) | enum |\r\n| calendarId | ServiceLevelAgreementMeasure->Calendar_Id | integer | int64 |\r\n| resettableMeasure | ServiceLevelAgreementMeasure->ResettableMeasure | boolean | |\r\n| sequenceNumber | ServiceLevelAgreementMeasure->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasure->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| isMain | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| workOrderStartStatusId | Nullable | False | |\r\n| workOrderEndStatusId | Nullable | False | |\r\n| duration | Nullable | False | |\r\n| duration | Min Value | > 00:00:00| |\r\n| calendarType | Nullable | False | |\r\n| calendarId | Nullable | False | ServiceLevelAgreementMeasure->CalendarType eq 'Custom' |\r\n| calendarId | Nullable | True | ServiceLevelAgreementMeasure->CalendarType ne 'Custom' |\r\n\r\n", "operationId": "BatchUpdateServiceLevelAgreementMeasure", "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/BatchUpdateServiceLevelAgreementMeasureResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure 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": [ "Service Level Agreement Measure" ], "summary": "Delete a collection of existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasure->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": "BatchDeleteServiceLevelAgreementMeasure", "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/BatchDeleteServiceLevelAgreementMeasureResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure 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/WM/ServiceLevelAgreements/Measures/{id}/Active": { "patch": { "tags": [ "Service Level Agreement Measure" ], "summary": "Change the IsActive status for an existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementMeasure->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": "ChangeServiceLevelAgreementMeasureIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/{id}/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Measure" ], "summary": "Change the PermissionTree for an existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasure->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": "ChangeServiceLevelAgreementMeasurePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Sync/Pull": { "post": { "tags": [ "Service Level Agreement Measure" ], "summary": "Pull Service Level Agreement Measure Template Updates", "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| serviceLevelAgreementMeasureIds | PullServiceLevelAgreementMeasureTemplateUpdates->ServiceLevelAgreementMeasureIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "PullServiceLevelAgreementMeasureTemplateUpdates", "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/PullServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Sync/Push": { "post": { "tags": [ "Service Level Agreement Measure" ], "summary": "Push Service Level Agreement Measure Template Updates", "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| serviceLevelAgreementMeasureIds | PushServiceLevelAgreementMeasureTemplateUpdates->ServiceLevelAgreementMeasureIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "PushServiceLevelAgreementMeasureTemplateUpdates", "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/PushServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Batch/Active": { "patch": { "tags": [ "Service Level Agreement Measure" ], "summary": "Change the IsActive status for a collection of existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementMeasure->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": "BatchChangeServiceLevelAgreementMeasureIsActive", "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/BatchChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Batch/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Measure" ], "summary": "Change the PermissionTree status for a collection of existing Service Level Agreement Measure 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 | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasure->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": "BatchChangeServiceLevelAgreementMeasurePermissionTree", "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/BatchChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/FieldAssignments/{id}": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Get a Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| isActive | ServiceLevelAgreementMeasureFieldAssignment->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementMeasureFieldAssignment->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementMeasureFieldAssignment->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Description | string | |\r\n| permissionTreeId | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| notes | ServiceLevelAgreementMeasureFieldAssignment->Notes | string | |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| sequenceNumber | ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber | integer | int32 |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n", "operationId": "GetServiceLevelAgreementMeasureFieldAssignment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Field Assignment Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Service Level Agreement Measure Field Assignment", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureFieldAssignmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Update an existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n| sequenceNumber | ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureFieldAssignment->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 | <= 255 chars| |\r\n| targetFieldType | Nullable | False | |\r\n| targetField | Nullable | False | |\r\n| actionWhen | Nullable | False | |\r\n| valueSource | Nullable | False | |\r\n\r\n", "operationId": "UpdateServiceLevelAgreementMeasureFieldAssignment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Field Assignment Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Field Assignment 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": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Delete an existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->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": "DeleteServiceLevelAgreementMeasureFieldAssignment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Field Assignment Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Field Assignment 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/WM/ServiceLevelAgreements/Measures/FieldAssignments": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Get a collection of Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| serviceLevelAgreementMeasureCode | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Description | string | |\r\n| code | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n", "operationId": "GetServiceLevelAgreementMeasureFieldAssignmentCollection", "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 Service Level Agreement Measure Field Assignment collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureFieldAssignmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Create a new Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n| sequenceNumber | ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureFieldAssignment->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| serviceLevelAgreementMeasureId | Required | True | |\r\n| serviceLevelAgreementMeasureId | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| targetFieldType | Required | True | |\r\n| targetFieldType | Nullable | False | |\r\n| targetField | Required | True | |\r\n| targetField | Nullable | False | |\r\n| actionWhen | Required | True | |\r\n| actionWhen | Nullable | False | |\r\n| valueSource | Required | True | |\r\n| valueSource | Nullable | False | |\r\n\r\n", "operationId": "CreateServiceLevelAgreementMeasureFieldAssignment", "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/CreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/{serviceLevelAgreementMeasureId}/FieldAssignments": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Get a collection of Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n", "operationId": "GetServiceLevelAgreementMeasureFieldAssignmentForServiceLevelAgreementMeasureCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "serviceLevelAgreementMeasureId", "in": "path", "required": true, "description": "Service Level Agreement Measure 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 Service Level Agreement Measure Field Assignment collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureFieldAssignmentForServiceLevelAgreementMeasureCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/FieldAssignments/Lookups/LookupServiceLevelAgreementMeasureFieldAssignmentChangePermissionTree": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Lookup the permission set for changing the Service Level Agreement Measure Field Assignment.", "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": "LookupServiceLevelAgreementMeasureFieldAssignmentChangePermissionTree", "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/ServiceLevelAgreementMeasureFieldAssignmentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/FieldAssignments/Lookups/LookupServiceLevelAgreementMeasureFieldAssignmentEntityProperty": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Service Level Agreement Measure Field Assignment", "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| path | EntityMetadataPropertySummary->Path | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureFieldAssignmentEntityProperty", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Entity Property Metadata Summary collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureFieldAssignmentEntityPropertyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/FieldAssignments/Lookups/LookupServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTree": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Lookup the permission set for creating the Service Level Agreement Measure Field Assignment.", "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": "LookupServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTree", "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/ServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/FieldAssignments/Lookups/LookupServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementMeasure": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Lookup the Service Level Agreement for the Service Level Agreement Measure Field Assignment.", "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 | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasure->Code | string | |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementMeasure", "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 Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/FieldAssignments/Batch/{ids}": { "get": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Get a collection of Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| isActive | ServiceLevelAgreementMeasureFieldAssignment->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementMeasureFieldAssignment->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementMeasureFieldAssignment->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Description | string | |\r\n| permissionTreeId | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| notes | ServiceLevelAgreementMeasureFieldAssignment->Notes | string | |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| sequenceNumber | ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber | integer | int32 |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n", "operationId": "BatchGetServiceLevelAgreementMeasureFieldAssignment", "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 Service Level Agreement Measure Field Assignment 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 Service Level Agreement Measure Field Assignment collection", "schema": { "$ref": "#/definitions/BatchGetServiceLevelAgreementMeasureFieldAssignmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/FieldAssignments/Batch": { "post": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Create a new collection of Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n| sequenceNumber | ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureFieldAssignment->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| serviceLevelAgreementMeasureId | Required | True | |\r\n| serviceLevelAgreementMeasureId | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| targetFieldType | Required | True | |\r\n| targetFieldType | Nullable | False | |\r\n| targetField | Required | True | |\r\n| targetField | Nullable | False | |\r\n| actionWhen | Required | True | |\r\n| actionWhen | Nullable | False | |\r\n| valueSource | Required | True | |\r\n| valueSource | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateServiceLevelAgreementMeasureFieldAssignment", "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/BatchCreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Field Assignment 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": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Update a collection of existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasureFieldAssignment->Code | string | |\r\n| description | ServiceLevelAgreementMeasureFieldAssignment->Description | string | |\r\n| targetFieldType | ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType | string (Allowed values: [Boolean, String, Date, DateTime]) | enum |\r\n| targetField | ServiceLevelAgreementMeasureFieldAssignment->TargetField | string | |\r\n| actionWhen | ServiceLevelAgreementMeasureFieldAssignment->ActionWhen | string (Allowed values: [MeasureStart, MeasureEnd]) | enum |\r\n| valueSource | ServiceLevelAgreementMeasureFieldAssignment->ValueSource | string (Allowed values: [MeasureStart, MeasureExpectedCompletion, MeasureStartPlusInterval, Static]) | enum |\r\n| value | ServiceLevelAgreementMeasureFieldAssignment->Value | object | composite |\r\n| sequenceNumber | ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureFieldAssignment->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 | <= 255 chars| |\r\n| targetFieldType | Nullable | False | |\r\n| targetField | Nullable | False | |\r\n| actionWhen | Nullable | False | |\r\n| valueSource | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateServiceLevelAgreementMeasureFieldAssignment", "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/BatchUpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Field Assignment 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": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Delete a collection of existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->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": "BatchDeleteServiceLevelAgreementMeasureFieldAssignment", "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/BatchDeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Field Assignment 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/WM/ServiceLevelAgreements/Measures/FieldAssignments/{id}/Active": { "patch": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Change the IsActive status for an existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementMeasureFieldAssignment->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": "ChangeServiceLevelAgreementMeasureFieldAssignmentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Field Assignment Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/FieldAssignments/{id}/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Change the PermissionTree for an existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasureFieldAssignment->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": "ChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Field Assignment Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/FieldAssignments/Batch/Active": { "patch": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Change the IsActive status for a collection of existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementMeasureFieldAssignment->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": "BatchChangeServiceLevelAgreementMeasureFieldAssignmentIsActive", "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/BatchChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/FieldAssignments/Batch/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Measure Field Assignment" ], "summary": "Change the PermissionTree status for a collection of existing Service Level Agreement Measure Field Assignment 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 | ServiceLevelAgreementMeasureFieldAssignment->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureFieldAssignment->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasureFieldAssignment->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": "BatchChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTree", "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/BatchChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Triggers/{id}": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Get a Service Level Agreement Measure Trigger resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| isActive | ServiceLevelAgreementMeasureTrigger->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementMeasureTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementMeasureTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementMeasureTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementMeasureTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementMeasureTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementMeasureTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementMeasureTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementMeasureTrigger->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasureTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementMeasureTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementMeasureTrigger->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| changeDataTriggerId | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Description | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| notes | ServiceLevelAgreementMeasureTrigger->Notes | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ServiceLevelAgreementMeasureTrigger->SequenceNumber | integer | int32 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Description | string | |\r\n", "operationId": "GetServiceLevelAgreementMeasureTrigger", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Trigger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Service Level Agreement Measure Trigger", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureTriggerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Update an existing Service Level Agreement Measure Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ServiceLevelAgreementMeasureTrigger->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureTrigger->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| percentage | Nullable | False | |\r\n| percentage | Min Value | > 0| |\r\n| repeatNotificationLimit | Min Value | > 0| ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "UpdateServiceLevelAgreementMeasureTrigger", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Trigger 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": [ "Service Level Agreement Measure Trigger" ], "summary": "Delete an existing Service Level Agreement Measure Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ServiceLevelAgreementMeasureTrigger->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": "DeleteServiceLevelAgreementMeasureTrigger", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Trigger Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Trigger 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/WM/ServiceLevelAgreements/Measures/Triggers": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Get a collection of Service Level Agreement Measure Trigger resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Description | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| changeDataTriggerCode | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Description | string | |\r\n", "operationId": "GetServiceLevelAgreementMeasureTriggerCollection", "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 Service Level Agreement Measure Trigger collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureTriggerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Create a new Service Level Agreement Measure Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | ServiceLevelAgreementMeasureTrigger->PermissionTree_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ServiceLevelAgreementMeasureTrigger->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| serviceLevelAgreementMeasureId | Required | True | |\r\n| serviceLevelAgreementMeasureId | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| percentage | Required | True | |\r\n| percentage | Nullable | False | |\r\n| percentage | Min Value | > 0| |\r\n| repeatNotificationLimit | Min Value | > 0| ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "CreateServiceLevelAgreementMeasureTrigger", "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/CreateServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/{serviceLevelAgreementMeasureId}/Triggers": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Get a collection of Service Level Agreement Measure Trigger resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| changeDataTriggerCode | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Description | string | |\r\n", "operationId": "GetServiceLevelAgreementMeasureTriggerForServiceLevelAgreementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "serviceLevelAgreementMeasureId", "in": "path", "required": true, "description": "Service Level Agreement Measure 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 Service Level Agreement Measure Trigger collection", "schema": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureTriggerForServiceLevelAgreementMeasureCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Triggers/Lookups/LookupServiceLevelAgreementMeasureTriggerChangePermissionTree": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Lookup the permission set for changing the Service Level Agreement Measure Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupServiceLevelAgreementMeasureTriggerChangePermissionTree", "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/ServiceLevelAgreementMeasureTriggerChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Triggers/Lookups/LookupServiceLevelAgreementMeasureTriggerInsertPermissionTree": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Lookup the permission set for creating the Service Level Agreement Measure Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupServiceLevelAgreementMeasureTriggerInsertPermissionTree", "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/ServiceLevelAgreementMeasureTriggerInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Triggers/Lookups/LookupServiceLevelAgreementMeasureTriggerServiceLevelAgreementMeasure": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Lookup the Service Level Agreement for the Service Level Agreement Measure Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasure->Code | string | |\r\n| description | ServiceLevelAgreementMeasure->Description | string | |\r\n", "operationId": "LookupServiceLevelAgreementMeasureTriggerServiceLevelAgreementMeasure", "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 Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/ServiceLevelAgreementMeasureTriggerServiceLevelAgreementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Triggers/Batch/{ids}": { "get": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Get a collection of Service Level Agreement Measure Trigger resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| isActive | ServiceLevelAgreementMeasureTrigger->IsActive | boolean | |\r\n| createdByUserId | ServiceLevelAgreementMeasureTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ServiceLevelAgreementMeasureTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ServiceLevelAgreementMeasureTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | ServiceLevelAgreementMeasureTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | ServiceLevelAgreementMeasureTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ServiceLevelAgreementMeasureTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ServiceLevelAgreementMeasureTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ServiceLevelAgreementMeasureTrigger->ModifiedOn | string | date-time |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasureTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ServiceLevelAgreementMeasureTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ServiceLevelAgreementMeasureTrigger->PermissionTree_Description | string | |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| changeDataTriggerId | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Description | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| notes | ServiceLevelAgreementMeasureTrigger->Notes | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ServiceLevelAgreementMeasureTrigger->SequenceNumber | integer | int32 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Description | string | |\r\n", "operationId": "BatchGetServiceLevelAgreementMeasureTrigger", "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 Service Level Agreement Measure Trigger 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 Service Level Agreement Measure Trigger collection", "schema": { "$ref": "#/definitions/BatchGetServiceLevelAgreementMeasureTriggerResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/ServiceLevelAgreements/Measures/Triggers/Batch": { "post": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Create a new collection of Service Level Agreement Measure Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | ServiceLevelAgreementMeasureTrigger->PermissionTree_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureId | ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ServiceLevelAgreementMeasureTrigger->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| serviceLevelAgreementMeasureId | Required | True | |\r\n| serviceLevelAgreementMeasureId | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| percentage | Required | True | |\r\n| percentage | Nullable | False | |\r\n| percentage | Min Value | > 0| |\r\n| repeatNotificationLimit | Min Value | > 0| ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "BatchCreateServiceLevelAgreementMeasureTrigger", "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/BatchCreateServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Trigger 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": [ "Service Level Agreement Measure Trigger" ], "summary": "Update a collection of existing Service Level Agreement Measure Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| code | ServiceLevelAgreementMeasureTrigger->Code | string | |\r\n| description | ServiceLevelAgreementMeasureTrigger->Description | string | |\r\n| percentage | ServiceLevelAgreementMeasureTrigger->Percentage | number | decimal |\r\n| repeatNotification | ServiceLevelAgreementMeasureTrigger->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ServiceLevelAgreementMeasureTrigger->SequenceNumber | integer | int32 |\r\n| notes | ServiceLevelAgreementMeasureTrigger->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| percentage | Nullable | False | |\r\n| percentage | Min Value | > 0| |\r\n| repeatNotificationLimit | Min Value | > 0| ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "BatchUpdateServiceLevelAgreementMeasureTrigger", "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/BatchUpdateServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Trigger 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": [ "Service Level Agreement Measure Trigger" ], "summary": "Delete a collection of existing Service Level Agreement Measure Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureTrigger->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": "BatchDeleteServiceLevelAgreementMeasureTrigger", "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/BatchDeleteServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Service Level Agreement Measure Trigger 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/WM/ServiceLevelAgreements/Measures/Triggers/{id}/Active": { "patch": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Change the IsActive status for an existing Service Level Agreement Measure Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementMeasureTrigger->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": "ChangeServiceLevelAgreementMeasureTriggerIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Triggers/{id}/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Change the PermissionTree for an existing Service Level Agreement Measure Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasureTrigger->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": "ChangeServiceLevelAgreementMeasureTriggerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Service Level Agreement Measure Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Triggers/Batch/Active": { "patch": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Change the IsActive status for a collection of existing Service Level Agreement Measure Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| isActive | ServiceLevelAgreementMeasureTrigger->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": "BatchChangeServiceLevelAgreementMeasureTriggerIsActive", "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/BatchChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest" } }, { "$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/WM/ServiceLevelAgreements/Measures/Triggers/Batch/PermissionTree": { "patch": { "tags": [ "Service Level Agreement Measure Trigger" ], "summary": "Change the PermissionTree status for a collection of existing Service Level Agreement Measure Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ServiceLevelAgreementMeasureTrigger->Id | integer | int64 |\r\n| version | ServiceLevelAgreementMeasureTrigger->Version | integer | int32 |\r\n| permissionTreeId | ServiceLevelAgreementMeasureTrigger->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": "BatchChangeServiceLevelAgreementMeasureTriggerPermissionTree", "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/BatchChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}": { "get": { "tags": [ "Work Order" ], "summary": "Get a Work Order 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| geographicId | WorkOrder->GeographicId | integer | int64 |\r\n| geographicEndPosition | WorkOrder->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | WorkOrder->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | WorkOrder->GeographicLength | number | decimal |\r\n| geographicLocation | WorkOrder->GeographicLocation | object | |\r\n| geographicNotes | WorkOrder->GeographicNotes | string | |\r\n| geographicReferenceEntityId | WorkOrder->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | WorkOrder->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | WorkOrder->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrder->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | WorkOrder->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | WorkOrder->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | WorkOrder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrder->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrder->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrder->ModifiedOn | string | date-time |\r\n| version | WorkOrder->Version | integer | int32 |\r\n| permissionTreeId | WorkOrder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrder->PermissionTree_Description | string | |\r\n| code | WorkOrder->Code | string | |\r\n| codeCounter | WorkOrder->CodeCounter | integer | int64 |\r\n| codePrefix | WorkOrder->CodePrefix | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| siteDescription | WorkOrder->Site_Description | string | |\r\n| requester | WorkOrder->Requester | string | |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| requesterContactCode | WorkOrder->RequesterContact_Code | string | |\r\n| id | WorkOrder->Id | integer | int64 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| alarmDescription | WorkOrder->Alarm_Description | string | |\r\n| analysisComponentId | WorkOrder->AnalysisComponent_Id | integer | int64 |\r\n| analysisComponentCode | WorkOrder->AnalysisComponent_Code | string | |\r\n| analysisComponentDescription | WorkOrder->AnalysisComponent_Description | string | |\r\n| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| assetDescription | WorkOrder->Asset_Description | string | |\r\n| assetIsMsi | WorkOrder->Asset_IsMsi | boolean | |\r\n| assetRecordType | WorkOrder->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetDevelopmentStatus | WorkOrder->Asset_DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| assetIsForScheduledWorkOnly | WorkOrder->Asset_IsForScheduledWorkOnly | boolean | |\r\n| assetNearestRegularAssetId | WorkOrder->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetSerialNumber | WorkOrder->Asset_NearestRegularAsset_SerialNumber | string | |\r\n| assetNearestRegularAssetCode | WorkOrder->Asset_NearestRegularAsset_Code | string | |\r\n| assetNearestRegularAssetDescription | WorkOrder->Asset_NearestRegularAsset_Description | string | |\r\n| assetNearestRegularAssetParentAssetId | WorkOrder->Asset_NearestRegularAsset_ParentAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetParentAssetCode | WorkOrder->Asset_NearestRegularAsset_ParentAsset_Code | string | |\r\n| assetNearestRegularAssetParentAssetDescription | WorkOrder->Asset_NearestRegularAsset_ParentAsset_Description | string | |\r\n| assetParentAssetId | WorkOrder->Asset_ParentAsset_Id | integer | int64 |\r\n| assetParentAssetDescription | WorkOrder->Asset_ParentAsset_Description | string | |\r\n| assetTreePathId | WorkOrder->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | WorkOrder->Asset_TreePathItems | array | array |\r\n| assetWarranty | WorkOrder->Asset_Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n| assetModificationApproved | WorkOrder->AssetModificationApproved | boolean | |\r\n| assetModificationApprovedById | WorkOrder->AssetModificationApprovedBy_Id | integer | int64 |\r\n| assetModificationApprovedByCode | WorkOrder->AssetModificationApprovedBy_Code | string | |\r\n| assetModificationApprovedByFullName | WorkOrder->AssetModificationApprovedBy_FullName | string | |\r\n| assetModificationApprovedOn | WorkOrder->AssetModificationApprovedOn | string | date-time |\r\n| assetModificationInvestigated | WorkOrder->AssetModificationInvestigated | boolean | |\r\n| assetModificationInvestigatedById | WorkOrder->AssetModificationInvestigatedBy_Id | integer | int64 |\r\n| assetModificationInvestigatedByCode | WorkOrder->AssetModificationInvestigatedBy_Code | string | |\r\n| assetModificationInvestigatedByFullName | WorkOrder->AssetModificationInvestigatedBy_FullName | string | |\r\n| assetModificationInvestigatedOn | WorkOrder->AssetModificationInvestigatedOn | string | date-time |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| assetMoved | WorkOrder->AssetMoved | boolean | |\r\n| assetTypeId | WorkOrder->AssetType_Id | integer | int64 |\r\n| assetTypeCode | WorkOrder->AssetType_Code | string | |\r\n| assetTypeDescription | WorkOrder->AssetType_Description | string | |\r\n| autoCalculateEstimatedDowntime | WorkOrder->AutoCalculateEstimatedDowntime | boolean | |\r\n| autoCalculateEstimatedDuration | WorkOrder->AutoCalculateEstimatedDuration | boolean | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| contactDescription | WorkOrder->ContactDescription | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| costCentreCode | WorkOrder->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrder->CostCentre_Description | string | |\r\n| description | WorkOrder->Description | string | |\r\n| duration | WorkOrder->Duration | string | duration |\r\n| email | WorkOrder->Email | string | email |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| eventCode | WorkOrder->Event_Code | string | |\r\n| eventDescription | WorkOrder->Event_Description | string | |\r\n| failedComponentId | WorkOrder->FailedComponent_Id | integer | int64 |\r\n| failedComponentCode | WorkOrder->FailedComponent_Code | string | |\r\n| failedComponentDescription | WorkOrder->FailedComponent_Description | string | |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | WorkOrder->FailureCause_Code | string | |\r\n| failureCauseDescription | WorkOrder->FailureCause_Description | string | |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | WorkOrder->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | WorkOrder->FailureCauseType_Description | string | |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | WorkOrder->FailureMechanism_Code | string | |\r\n| failureMechanismDescription | WorkOrder->FailureMechanism_Description | string | |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | WorkOrder->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | WorkOrder->FailureMechanismType_Description | string | |\r\n| failureModeId | WorkOrder->FailureMode_Id | integer | int64 |\r\n| failureModeCode | WorkOrder->FailureMode_Code | string | |\r\n| failureModeDescription | WorkOrder->FailureMode_Description | string | |\r\n| failureModeTypeId | WorkOrder->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | WorkOrder->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | WorkOrder->FailureModeType_Description | string | |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | WorkOrder->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrder->GeneralLedger_Description | string | |\r\n| hasServiceLevelAgreement | WorkOrder->HasServiceLevelAgreement | boolean | |\r\n| intervalId | WorkOrder->Interval_Id | integer | int64 |\r\n| intervalCode | WorkOrder->Interval_Code | string | |\r\n| intervalDescription | WorkOrder->Interval_Description | string | |\r\n| isFailure | WorkOrder->IsFailure | boolean | |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| latestWorkOrderProgressLogId | WorkOrder->LatestWorkOrderProgressLog_Id | integer | int64 |\r\n| latestWorkOrderProgressLogProgressEventId | WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Id | integer | int64 |\r\n| latestWorkOrderProgressLogProgressEventCode | WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Code | string | |\r\n| latestWorkOrderProgressLogProgressEventDescription | WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Description | string | |\r\n| latestWorkOrderProgressLogExecutedOn | WorkOrder->LatestWorkOrderProgressLog_ExecutedOn | string | date-time |\r\n| latestWorkOrderStatusChangeId | WorkOrder->LatestWorkOrderStatusChange_Id | integer | int64 |\r\n| latestWorkOrderStatusChangeRemark | WorkOrder->LatestWorkOrderStatusChange_Remark | string | |\r\n| locationId | WorkOrder->Location_Id | integer | int64 |\r\n| locationCode | WorkOrder->Location_Code | string | |\r\n| locationDescription | WorkOrder->Location_Description | string | |\r\n| mainScheduledReading | WorkOrder->MainScheduledReading | number | decimal |\r\n| mainServiceLevelAgreementId | WorkOrder->MainServiceLevelAgreement_Id | integer | int64 |\r\n| mainServiceLevelAgreementServiceLevelAgreementId | WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Id | integer | int64 |\r\n| mainServiceLevelAgreementServiceLevelAgreementCode | WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Code | string | |\r\n| mainServiceLevelAgreementServiceLevelAgreementDescription | WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Description | string | |\r\n| mainServiceLevelAgreementMainMeasurePercentage | WorkOrder->MainServiceLevelAgreement_MainMeasurePercentage | number | decimal |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkOrder->Notes | string | |\r\n| origin | WorkOrder->Origin | string (Allowed values: [Scheduled, Manual, Alarm, FollowUp]) | enum |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| parentWorkOrderCode | WorkOrder->ParentWorkOrder_Code | string | |\r\n| parentWorkOrderDescription | WorkOrder->ParentWorkOrder_Description | string | |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone1TypeCode | WorkOrder->Phone1Type_Code | string | |\r\n| phone1TypeDescription | WorkOrder->Phone1Type_Description | string | |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| phone2TypeCode | WorkOrder->Phone2Type_Code | string | |\r\n| phone2TypeDescription | WorkOrder->Phone2Type_Description | string | |\r\n| priority | WorkOrder->Priority | number | decimal |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| repairTypeCode | WorkOrder->RepairType_Code | string | |\r\n| repairTypeDescription | WorkOrder->RepairType_Description | string | |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| scheduledMeters | WorkOrder->ScheduledMeters | string | |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrder->Section_Code | string | |\r\n| sectionDescription | WorkOrder->Section_Description | string | |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| staffMemberCode | WorkOrder->StaffMember_Code | string | |\r\n| staffMemberResourceType | WorkOrder->StaffMember_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| staffMemberContactDetailId | WorkOrder->StaffMember_ContactDetailId | integer | int64 |\r\n| staffMemberContactDetailFirstName | WorkOrder->StaffMember_ContactDetailFirstName | string | |\r\n| staffMemberContactDetailFullName | WorkOrder->StaffMember_ContactDetailFullName | string | |\r\n| staffMemberContactDetailLastName | WorkOrder->StaffMember_ContactDetailLastName | string | |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| statusId | WorkOrder->Status_Id | integer | int64 |\r\n| statusCode | WorkOrder->Status_Code | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| statusDescription | WorkOrder->Status_Description | string | |\r\n| statusSequenceNumber | WorkOrder->Status_SequenceNumber | integer | int32 |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | WorkOrder->TaskClassification1_Code | string | |\r\n| taskClassification1Description | WorkOrder->TaskClassification1_Description | string | |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | WorkOrder->TaskClassification2_Code | string | |\r\n| taskClassification2Description | WorkOrder->TaskClassification2_Description | string | |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | WorkOrder->TaskClassification3_Code | string | |\r\n| taskClassification3Description | WorkOrder->TaskClassification3_Description | string | |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | WorkOrder->TaskClassification4_Code | string | |\r\n| taskClassification4Description | WorkOrder->TaskClassification4_Description | string | |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | WorkOrder->TaskClassification5_Code | string | |\r\n| taskClassification5Description | WorkOrder->TaskClassification5_Description | string | |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | WorkOrder->TaskClassification6_Code | string | |\r\n| taskClassification6Description | WorkOrder->TaskClassification6_Description | string | |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | WorkOrder->TaskClassification7_Code | string | |\r\n| taskClassification7Description | WorkOrder->TaskClassification7_Description | string | |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | WorkOrder->TaskClassification8_Code | string | |\r\n| taskClassification8Description | WorkOrder->TaskClassification8_Description | string | |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| tradeCode | WorkOrder->Trade_Code | string | |\r\n| tradeDescription | WorkOrder->Trade_Description | string | |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | WorkOrder->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| useGlobalLookupLists | WorkOrder->UseGlobalLookupLists | boolean | |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification1Code | WorkOrder->WorkClassification1_Code | string | |\r\n| workClassification1Description | WorkOrder->WorkClassification1_Description | string | |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification2Code | WorkOrder->WorkClassification2_Code | string | |\r\n| workClassification2Description | WorkOrder->WorkClassification2_Description | string | |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification3Code | WorkOrder->WorkClassification3_Code | string | |\r\n| workClassification3Description | WorkOrder->WorkClassification3_Description | string | |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification4Code | WorkOrder->WorkClassification4_Code | string | |\r\n| workClassification4Description | WorkOrder->WorkClassification4_Description | string | |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| workClassification5Code | WorkOrder->WorkClassification5_Code | string | |\r\n| workClassification5Description | WorkOrder->WorkClassification5_Description | string | |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| workOrderImportanceCode | WorkOrder->WorkOrderImportance_Code | string | |\r\n| workOrderImportanceDescription | WorkOrder->WorkOrderImportance_Description | string | |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n", "operationId": "GetWorkOrder", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order", "schema": { "$ref": "#/definitions/GetWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order" ], "summary": "Update an existing Work Order 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 | WorkOrder->Version | integer | int32 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| assetModificationApproved | WorkOrder->AssetModificationApproved | boolean | |\r\n| assetModificationInvestigated | WorkOrder->AssetModificationInvestigated | boolean | |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| autoCalculateEstimatedDowntime | WorkOrder->AutoCalculateEstimatedDowntime | boolean | |\r\n| autoCalculateEstimatedDuration | WorkOrder->AutoCalculateEstimatedDuration | boolean | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| contactDescription | WorkOrder->ContactDescription | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| email | WorkOrder->Email | string | email |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| failedComponentId | WorkOrder->FailedComponent_Id | integer | int64 |\r\n| analysisComponentId | WorkOrder->AnalysisComponent_Id | integer | int64 |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureModeId | WorkOrder->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | WorkOrder->FailureModeType_Id | integer | int64 |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | WorkOrder->Requester | string | |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| useGlobalLookupLists | WorkOrder->UseGlobalLookupLists | boolean | |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| priority | WorkOrder->Priority | number | decimal |\r\n| notes | WorkOrder->Notes | string | |\r\n| geographicLocation | WorkOrder->GeographicLocation | object | |\r\n| geographicStartPosition | WorkOrder->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkOrder->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkOrder->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrder->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkOrder->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkOrder->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkOrder->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| 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| siteId | Nullable | False | |\r\n| assetId | Min Value | > 1| |\r\n| assetModificationApproved | Nullable | False | |\r\n| assetModificationInvestigated | Nullable | False | |\r\n| costCentreId | Nullable | False | |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| estimatedDowntime | Nullable | False | |\r\n| estimatedDowntime | Min Value | >= 00:00:00| |\r\n| estimatedDuration | Nullable | False | |\r\n| estimatedDuration | Min Value | >= 00:00:00| |\r\n| failedComponentId | Nullable | True | WorkOrder->Asset_Id eq NULL |\r\n| failureCauseTypeId | Nullable | False | WorkOrder->FailureCause_Id ne NULL |\r\n| failureMechanismTypeId | Nullable | False | WorkOrder->FailureMechanism_Id ne NULL |\r\n| failureModeTypeId | Nullable | False | WorkOrder->FailureMode_Id ne NULL |\r\n| generalLedgerId | Nullable | False | |\r\n| isPermitRequired | Nullable | False | |\r\n| requesterContactId | Nullable | True | WorkOrder->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkOrder->RequesterType eq 'Contact' |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| progressPercentage | Min Value | >= 0| |\r\n| receivedOn | Nullable | False | |\r\n| requester | Nullable | False | WorkOrder->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkOrder->RequesterType eq 'FreeText' |\r\n| requiredBy | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| useGlobalLookupLists | Nullable | False | |\r\n| workRequired | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrder", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/{id}/NearestRegularAsset/Attributes": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Regular Asset Attribute resources for the nearest Regular Asset associated with the Work Order 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| id | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n| createdOn | RegularAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderNearestRegularAssetAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/GetWorkOrderNearestRegularAssetAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{id}/NearestRegularAsset/OptionValues": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Regular Asset Option Value resources for the nearest Regular Asset associated with the Work Order 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| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | RegularAssetOptionValue->IsActive | boolean | |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetOptionValue->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetOptionValue->RegularAsset_Description | string | |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionOptionCategoryCode | RegularAssetOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementCode | RegularAssetOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| optionDataType | RegularAssetOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | RegularAssetOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetOptionValue->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | RegularAssetOptionValue->Option_Code | string | |\r\n| optionDescription | RegularAssetOptionValue->Option_Description | string | |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| isCustom | RegularAssetOptionValue->IsCustom | boolean | |\r\n| createdOn | RegularAssetOptionValue->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetOptionValue->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderNearestRegularAssetOptionValueCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/GetWorkOrderNearestRegularAssetOptionValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{id}/FollowUpWorkOrders": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Work Order resources for the Work Order.", "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 | WorkOrder->Id | integer | int64 |\r\n| createdOn | WorkOrder->CreatedOn | string | date-time |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| origin | WorkOrder->Origin | string (Allowed values: [Scheduled, Manual, Alarm, FollowUp]) | enum |\r\n| statusId | WorkOrder->Status_Id | integer | int64 |\r\n| statusCode | WorkOrder->Status_Code | string | |\r\n| statusDescription | WorkOrder->Status_Description | string | |\r\n", "operationId": "GetFollowUpWorkOrderForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/GetFollowUpWorkOrderForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{workOrderId}/requisitions": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Work Order resources for the Work Order.", "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 | Requisition->Id | integer | int64 |\r\n| code | Requisition->Code | string | |\r\n| notes | Requisition->Notes | string | |\r\n| permissionTreeId | Requisition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Requisition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Requisition->PermissionTree_Description | string | |\r\n| workOrderId | Requisition->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Requisition->WorkOrder_Code | string | |\r\n| workOrderDescription | Requisition->WorkOrder_Description | string | |\r\n| workOrderCostCentreId | Requisition->WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderCostCentreCode | Requisition->WorkOrder_CostCentre_Code | string | |\r\n| workOrderCostCentreDescription | Requisition->WorkOrder_CostCentre_Description | string | |\r\n| workOrderGeneralLedgerId | Requisition->WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderGeneralLedgerCode | Requisition->WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderGeneralLedgerDescription | Requisition->WorkOrder_GeneralLedger_Description | string | |\r\n| workOrderSiteId | Requisition->WorkOrder_Site_Id | integer | int64 |\r\n| workOrderSiteCode | Requisition->WorkOrder_Site_Code | string | |\r\n| workOrderSiteDescription | Requisition->WorkOrder_Site_Description | string | |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| statusId | Requisition->Status_Id | integer | int64 |\r\n| statusCode | Requisition->Status_Code | string | |\r\n| statusDescription | Requisition->Status_Description | string | |\r\n| statusBaseStatus | Requisition->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n| version | Requisition->Version | integer | int32 |\r\n| totalItemCost | Requisition->TotalItemCost | number | decimal |\r\n", "operationId": "GetRequisitionForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/GetRequisitionForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| assetDescription | WorkOrder->Asset_Description | string | |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| requester | WorkOrder->Requester | string | |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| siteDescription | WorkOrder->Site_Description | string | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| staffMemberCode | WorkOrder->StaffMember_Code | string | |\r\n| staffMemberContactDetailFullName | WorkOrder->StaffMember_ContactDetailFullName | string | |\r\n| staffMemberDefaultResourceTradeTradeId | WorkOrder->StaffMember_DefaultResourceTrade_Trade_Id | integer | int64 |\r\n| staffMemberDefaultResourceTradeTradeCode | WorkOrder->StaffMember_DefaultResourceTrade_Trade_Code | string | |\r\n| staffMemberDefaultResourceTradeTradeDescription | WorkOrder->StaffMember_DefaultResourceTrade_Trade_Description | string | |\r\n| statusId | WorkOrder->Status_Id | integer | int64 |\r\n| statusDescription | WorkOrder->Status_Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| version | WorkOrder->Version | integer | int32 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| scheduledMeters | WorkOrder->ScheduledMeters | string | |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n", "operationId": "GetWorkOrderCollection", "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 Work Order collection", "schema": { "$ref": "#/definitions/GetWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order" ], "summary": "Create a new Work Order 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| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| permissionTreeId | WorkOrder->PermissionTree_Id | integer | int64 |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| autoCalculateEstimatedDowntime | WorkOrder->AutoCalculateEstimatedDowntime | boolean | |\r\n| autoCalculateEstimatedDuration | WorkOrder->AutoCalculateEstimatedDuration | boolean | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| contactDescription | WorkOrder->ContactDescription | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| duration | WorkOrder->Duration | string | duration |\r\n| email | WorkOrder->Email | string | email |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| failedComponentId | WorkOrder->FailedComponent_Id | integer | int64 |\r\n| analysisComponentId | WorkOrder->AnalysisComponent_Id | integer | int64 |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureModeId | WorkOrder->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | WorkOrder->FailureModeType_Id | integer | int64 |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | WorkOrder->Requester | string | |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| useGlobalLookupLists | WorkOrder->UseGlobalLookupLists | boolean | |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n| notes | WorkOrder->Notes | string | |\r\n| geographicLocation | WorkOrder->GeographicLocation | object | |\r\n| geographicStartPosition | WorkOrder->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkOrder->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkOrder->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrder->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkOrder->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkOrder->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkOrder->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Min Value | > 1| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| duration | Min Value | >= 00:00:00| |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| estimatedDowntime | Nullable | False | |\r\n| estimatedDowntime | Min Value | >= 00:00:00| |\r\n| estimatedDuration | Nullable | False | |\r\n| estimatedDuration | Min Value | >= 00:00:00| |\r\n| failedComponentId | Nullable | True | WorkOrder->Asset_Id eq NULL |\r\n| failureCauseTypeId | Nullable | False | WorkOrder->FailureCause_Id ne NULL |\r\n| failureMechanismTypeId | Nullable | False | WorkOrder->FailureMechanism_Id ne NULL |\r\n| failureModeTypeId | Nullable | False | WorkOrder->FailureMode_Id ne NULL |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| isPermitRequired | Nullable | False | |\r\n| requesterContactId | Nullable | True | WorkOrder->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkOrder->RequesterType eq 'Contact' |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| progressPercentage | Min Value | >= 0| |\r\n| receivedOn | Nullable | False | |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requester | Nullable | False | WorkOrder->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkOrder->RequesterType eq 'FreeText' |\r\n| requiredBy | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| useGlobalLookupLists | Nullable | False | |\r\n| workRequired | Required | True | |\r\n| workRequired | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrder", "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/CreateWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/{workOrderId}/Movements": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Work Order Movement resources for the Work Order.", "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 | WorkOrderMovement->Id | integer | int64 |\r\n| version | WorkOrderMovement->Version | integer | int32 |\r\n| action | WorkOrderMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| createdOn | WorkOrderMovement->CreatedOn | string | date-time |\r\n| createdByUserFullName | WorkOrderMovement->CreatedByUser_FullName | string | |\r\n", "operationId": "GetMovementForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/GetMovementForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{workOrderId}/Tasks/Movements": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Work Order resources for the Work Order.", "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 | WorkOrderTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskMovement->Version | integer | int32 |\r\n| workOrderTaskTaskCode | WorkOrderTaskMovement->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskMovement->WorkOrderTask_TaskDescription | string | |\r\n| action | WorkOrderTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| createdOn | WorkOrderTaskMovement->CreatedOn | string | date-time |\r\n| workOrderMovementCreatedOn | WorkOrderTaskMovement->WorkOrderMovement_CreatedOn | string | date-time |\r\n| workOrderMovementCreatedByUserFullName | WorkOrderTaskMovement->WorkOrderMovement_CreatedByUser_FullName | string | |\r\n| workOrderMovementWorkOrderCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code | string | |\r\n| workOrderCode | WorkOrderTaskMovement->WorkOrder_Code | string | |\r\n", "operationId": "GetWorkOrderTaskMovementForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMovementForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderAlarm": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Alarm for the Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Alarm->Id | integer | int64 |\r\n| description | Alarm->Description | string | |\r\n", "operationId": "LookupWorkOrderAlarm", "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 Alarm collection", "schema": { "$ref": "#/definitions/WorkOrderAlarmLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderAnalysisComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Asset Component for the Work Order.", "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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| assetTreePathItems | AssetComponent->Asset_TreePathItems | array | array |\r\n| treePathItems | AssetComponent->TreePathItems | array | array |\r\n", "operationId": "LookupWorkOrderAnalysisComponent", "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 Asset Component collection", "schema": { "$ref": "#/definitions/WorkOrderAnalysisComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderAsset": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Asset for the Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| isPermitRequired | Asset->IsPermitRequired | boolean | |\r\n| siteId | Asset->Site_Id | integer | int64 |\r\n| siteCode | Asset->Site_Code | string | |\r\n| siteDescription | Asset->Site_Description | string | |\r\n| locationId | Asset->Location_Id | integer | int64 |\r\n| locationCode | Asset->Location_Code | string | |\r\n| locationDescription | Asset->Location_Description | string | |\r\n| isMsi | Asset->IsMsi | boolean | |\r\n| assetTypeCode | Asset->AssetType_Code | string | |\r\n| assetTypeDescription | Asset->AssetType_Description | string | |\r\n| barcode | Asset->Barcode | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| warranty | Asset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "LookupWorkOrderAsset", "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 Asset collection", "schema": { "$ref": "#/definitions/WorkOrderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderChangePermissionTree": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the permission set for changing the Work Order.", "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": "LookupWorkOrderChangePermissionTree", "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/WorkOrderChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderCostCentre": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Cost Centre for the Work Order.", "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 | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupWorkOrderCostCentre", "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 Cost Centre collection", "schema": { "$ref": "#/definitions/WorkOrderCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderEvent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Event for the Work Order.", "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 | Event->Id | integer | int64 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n", "operationId": "LookupWorkOrderEvent", "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 Event collection", "schema": { "$ref": "#/definitions/WorkOrderEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailedComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Asset Component for the Work Order.", "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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| assetTreePathItems | AssetComponent->Asset_TreePathItems | array | array |\r\n| treePathItems | AssetComponent->TreePathItems | array | array |\r\n", "operationId": "LookupWorkOrderFailedComponent", "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 Asset Component collection", "schema": { "$ref": "#/definitions/WorkOrderFailedComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureCauseForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Cause for the Work Order.", "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 | FailureCause->Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureCauseForAssetComponent", "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 Failure Cause collection", "schema": { "$ref": "#/definitions/WorkOrderFailureCauseForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureCauseForFailureCauseType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Cause for the Work Order.", "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 | FailureCause->Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureCauseForFailureCauseType", "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 Failure Cause collection", "schema": { "$ref": "#/definitions/WorkOrderFailureCauseForFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureCause": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Cause for the Work Order.", "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 | FailureCause->Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureCause", "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 Failure Cause collection", "schema": { "$ref": "#/definitions/WorkOrderFailureCauseLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureCauseTypeForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Cause Type for the Work Order.", "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 | FailureCauseType->Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n", "operationId": "LookupWorkOrderFailureCauseTypeForAssetComponent", "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 Failure Cause Type collection", "schema": { "$ref": "#/definitions/WorkOrderFailureCauseTypeForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureCauseType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Cause Type for the Work Order.", "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 | FailureCauseType->Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n", "operationId": "LookupWorkOrderFailureCauseType", "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 Failure Cause Type collection", "schema": { "$ref": "#/definitions/WorkOrderFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureMechanismForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mechanism for the Work Order.", "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 | FailureMechanism->Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureMechanismForAssetComponent", "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 Failure Mechanism collection", "schema": { "$ref": "#/definitions/WorkOrderFailureMechanismForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureMechanismForFailureMechanismType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mechanism for the Work Order.", "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 | FailureMechanism->Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureMechanismForFailureMechanismType", "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 Failure Mechanism collection", "schema": { "$ref": "#/definitions/WorkOrderFailureMechanismForFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureMechanism": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mechanism for the Work Order.", "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 | FailureMechanism->Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureMechanism", "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 Failure Mechanism collection", "schema": { "$ref": "#/definitions/WorkOrderFailureMechanismLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureMechanismTypeForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mechanism Type for the Work Order.", "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 | FailureMechanismType->Id | integer | int64 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n", "operationId": "LookupWorkOrderFailureMechanismTypeForAssetComponent", "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 Failure Mechanism Type collection", "schema": { "$ref": "#/definitions/WorkOrderFailureMechanismTypeForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureMechanismType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mechanism Type for the Work Order.", "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 | FailureMechanismType->Id | integer | int64 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n", "operationId": "LookupWorkOrderFailureMechanismType", "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 Failure Mechanism Type collection", "schema": { "$ref": "#/definitions/WorkOrderFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureModeForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mode for the Work Order.", "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 | FailureMode->Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureModeForAssetComponent", "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 Failure Mode collection", "schema": { "$ref": "#/definitions/WorkOrderFailureModeForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureModeForFailureModeType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mode for the Work Order.", "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 | FailureMode->Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureModeForFailureModeType", "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 Failure Mode collection", "schema": { "$ref": "#/definitions/WorkOrderFailureModeForFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureMode": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mode for the Work Order.", "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 | FailureMode->Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n", "operationId": "LookupWorkOrderFailureMode", "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 Failure Mode collection", "schema": { "$ref": "#/definitions/WorkOrderFailureModeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureModeTypeForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mode Type for the Work Order.", "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 | FailureModeType->Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n", "operationId": "LookupWorkOrderFailureModeTypeForAssetComponent", "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 Failure Mode Type collection", "schema": { "$ref": "#/definitions/WorkOrderFailureModeTypeForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFailureModeType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Failure Mode Type for the Work Order.", "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 | FailureModeType->Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n", "operationId": "LookupWorkOrderFailureModeType", "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 Failure Mode Type collection", "schema": { "$ref": "#/definitions/WorkOrderFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderFinancialYearPeriod": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Financial Year Period for the Work Order.", "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 | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupWorkOrderFinancialYearPeriod", "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 Financial Year Period collection", "schema": { "$ref": "#/definitions/WorkOrderFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderGeneralLedger": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the General Ledger for the Work Order.", "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 | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupWorkOrderGeneralLedger", "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 General Ledger collection", "schema": { "$ref": "#/definitions/WorkOrderGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderInsertParentWorkOrder": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the parent Work Order for the Follow-Up Work Order", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupWorkOrderInsertParentWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderInsertParentWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderInsertPermissionTree": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the permission set for creating the Work Order.", "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": "LookupWorkOrderInsertPermissionTree", "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/WorkOrderInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderMergeSourceWorkOrdersAsset": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Work Order filter by Asset to include for merging", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "LookupWorkOrderMergeSourceWorkOrdersAsset", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderMergeSourceWorkOrdersAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderMergeSourceWorkOrdersAssetWorkClass": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Work Order filter by to include for merging", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "LookupWorkOrderMergeSourceWorkOrdersAssetWorkClass", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderMergeSourceWorkOrdersAssetWorkClassLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderMergeSourceWorkOrdersAssetTypesOfWork": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Work Order filter by Asset and to include for merging", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "LookupWorkOrderMergeSourceWorkOrdersAssetTypesOfWork", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderMergeSourceWorkOrdersAssetTypesOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderMergeSourceWorkOrders": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Work Order filter by Site to include for merging", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "LookupWorkOrderMergeSourceWorkOrders", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderMergeSourceWorkOrdersLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderMergeSourceWorkOrderWorkClass": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Work Order filter by Site and Pragma.OnKey.AMPC.TypesOfWork.TypeOfWork to include for merging", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "LookupWorkOrderMergeSourceWorkOrderWorkClass", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderMergeSourceWorkOrderWorkClassLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderMergeSourceWorkOrderTypesOfWork": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Work Order filter by Site and Pragma.OnKey.AMPC.TypesOfWork.TypeOfWork to include for merging", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "LookupWorkOrderMergeSourceWorkOrderTypesOfWork", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderMergeSourceWorkOrderTypesOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderPhone1Type": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Phone Number Type for the Work Order.", "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 | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n", "operationId": "LookupWorkOrderPhone1Type", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/WorkOrderPhone1TypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderPhone2Type": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Phone Number Type for the Work Order.", "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 | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n", "operationId": "LookupWorkOrderPhone2Type", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/WorkOrderPhone2TypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderRepairTypeForAssetComponent": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Repair Type for the Work Order.", "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 | RepairType->Id | integer | int64 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n", "operationId": "LookupWorkOrderRepairTypeForAssetComponent", "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 Repair Type collection", "schema": { "$ref": "#/definitions/WorkOrderRepairTypeForAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderRepairType": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Repair Type for the Work Order.", "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 | RepairType->Id | integer | int64 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n", "operationId": "LookupWorkOrderRepairType", "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 Repair Type collection", "schema": { "$ref": "#/definitions/WorkOrderRepairTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderRequesterContact": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Requester Contact for the Work Order", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupWorkOrderRequesterContact", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkOrderRequesterContactLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderRequisition": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Requisition for the Work Order.", "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 | Requisition->Id | integer | int64 |\r\n| code | Requisition->Code | string | |\r\n", "operationId": "LookupWorkOrderRequisition", "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 Requisition collection", "schema": { "$ref": "#/definitions/WorkOrderRequisitionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderSection": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Section for the Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupWorkOrderSection", "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 Section collection", "schema": { "$ref": "#/definitions/WorkOrderSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderSite": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Site for the Work Order.", "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": "LookupWorkOrderSite", "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/WorkOrderSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderStaffMember": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the Staff Member for the Work Order", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupWorkOrderStaffMember", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkOrderStaffMemberLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderStatus": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Work Order Status for the Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "LookupWorkOrderStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/WorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification1": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 1 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification1", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification2": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 2 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification2", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification3": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 3 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification3", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification4": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 4 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification4", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification5": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 5 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification5", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification6": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 6 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification6", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification6LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification7": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 7 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification7", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification7LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTaskClassification8": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Order Task Classification 8 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskClassification8", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskClassification8LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTrade": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Trade for the Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupWorkOrderTrade", "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 Trade collection", "schema": { "$ref": "#/definitions/WorkOrderTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderTypeOfWork": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Type of Work for the Work Order.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n", "operationId": "LookupWorkOrderTypeOfWork", "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 Type of Work collection", "schema": { "$ref": "#/definitions/WorkOrderTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderUpdateParentWorkOrder": { "get": { "tags": [ "Work Order" ], "summary": "Lookup up the parent Work Order for the Follow-Up Work Order", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupWorkOrderUpdateParentWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderUpdateParentWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderWorkClassification1": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Classification 1 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderWorkClassification1", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderWorkClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderWorkClassification2": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Classification 2 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderWorkClassification2", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderWorkClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderWorkClassification3": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Classification 3 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderWorkClassification3", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderWorkClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderWorkClassification4": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Classification 4 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderWorkClassification4", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderWorkClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderWorkClassification5": { "get": { "tags": [ "Work Order" ], "summary": "Lookup Work Classification 5 for the Work Order", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderWorkClassification5", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderWorkClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Lookups/LookupWorkOrderWorkOrderImportance": { "get": { "tags": [ "Work Order" ], "summary": "Lookup the Work Order Importance for the Work Order.", "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 | WorkOrderImportance->Id | integer | int64 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n", "operationId": "LookupWorkOrderWorkOrderImportance", "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 Work Order Importance collection", "schema": { "$ref": "#/definitions/WorkOrderWorkOrderImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Batch/{ids}": { "get": { "tags": [ "Work Order" ], "summary": "Get a collection of Work Order 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| geographicId | WorkOrder->GeographicId | integer | int64 |\r\n| geographicEndPosition | WorkOrder->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | WorkOrder->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | WorkOrder->GeographicLength | number | decimal |\r\n| geographicLocation | WorkOrder->GeographicLocation | object | |\r\n| geographicNotes | WorkOrder->GeographicNotes | string | |\r\n| geographicReferenceEntityId | WorkOrder->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | WorkOrder->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | WorkOrder->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrder->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | WorkOrder->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | WorkOrder->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | WorkOrder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrder->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrder->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrder->ModifiedOn | string | date-time |\r\n| version | WorkOrder->Version | integer | int32 |\r\n| permissionTreeId | WorkOrder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrder->PermissionTree_Description | string | |\r\n| code | WorkOrder->Code | string | |\r\n| codeCounter | WorkOrder->CodeCounter | integer | int64 |\r\n| codePrefix | WorkOrder->CodePrefix | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| siteDescription | WorkOrder->Site_Description | string | |\r\n| requester | WorkOrder->Requester | string | |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| requesterContactCode | WorkOrder->RequesterContact_Code | string | |\r\n| id | WorkOrder->Id | integer | int64 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| alarmDescription | WorkOrder->Alarm_Description | string | |\r\n| analysisComponentId | WorkOrder->AnalysisComponent_Id | integer | int64 |\r\n| analysisComponentCode | WorkOrder->AnalysisComponent_Code | string | |\r\n| analysisComponentDescription | WorkOrder->AnalysisComponent_Description | string | |\r\n| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| assetDescription | WorkOrder->Asset_Description | string | |\r\n| assetIsMsi | WorkOrder->Asset_IsMsi | boolean | |\r\n| assetRecordType | WorkOrder->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetDevelopmentStatus | WorkOrder->Asset_DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| assetIsForScheduledWorkOnly | WorkOrder->Asset_IsForScheduledWorkOnly | boolean | |\r\n| assetNearestRegularAssetId | WorkOrder->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetSerialNumber | WorkOrder->Asset_NearestRegularAsset_SerialNumber | string | |\r\n| assetNearestRegularAssetCode | WorkOrder->Asset_NearestRegularAsset_Code | string | |\r\n| assetNearestRegularAssetDescription | WorkOrder->Asset_NearestRegularAsset_Description | string | |\r\n| assetNearestRegularAssetParentAssetId | WorkOrder->Asset_NearestRegularAsset_ParentAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetParentAssetCode | WorkOrder->Asset_NearestRegularAsset_ParentAsset_Code | string | |\r\n| assetNearestRegularAssetParentAssetDescription | WorkOrder->Asset_NearestRegularAsset_ParentAsset_Description | string | |\r\n| assetParentAssetId | WorkOrder->Asset_ParentAsset_Id | integer | int64 |\r\n| assetParentAssetDescription | WorkOrder->Asset_ParentAsset_Description | string | |\r\n| assetTreePathId | WorkOrder->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | WorkOrder->Asset_TreePathItems | array | array |\r\n| assetWarranty | WorkOrder->Asset_Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n| assetModificationApproved | WorkOrder->AssetModificationApproved | boolean | |\r\n| assetModificationApprovedById | WorkOrder->AssetModificationApprovedBy_Id | integer | int64 |\r\n| assetModificationApprovedByCode | WorkOrder->AssetModificationApprovedBy_Code | string | |\r\n| assetModificationApprovedByFullName | WorkOrder->AssetModificationApprovedBy_FullName | string | |\r\n| assetModificationApprovedOn | WorkOrder->AssetModificationApprovedOn | string | date-time |\r\n| assetModificationInvestigated | WorkOrder->AssetModificationInvestigated | boolean | |\r\n| assetModificationInvestigatedById | WorkOrder->AssetModificationInvestigatedBy_Id | integer | int64 |\r\n| assetModificationInvestigatedByCode | WorkOrder->AssetModificationInvestigatedBy_Code | string | |\r\n| assetModificationInvestigatedByFullName | WorkOrder->AssetModificationInvestigatedBy_FullName | string | |\r\n| assetModificationInvestigatedOn | WorkOrder->AssetModificationInvestigatedOn | string | date-time |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| assetMoved | WorkOrder->AssetMoved | boolean | |\r\n| assetTypeId | WorkOrder->AssetType_Id | integer | int64 |\r\n| assetTypeCode | WorkOrder->AssetType_Code | string | |\r\n| assetTypeDescription | WorkOrder->AssetType_Description | string | |\r\n| autoCalculateEstimatedDowntime | WorkOrder->AutoCalculateEstimatedDowntime | boolean | |\r\n| autoCalculateEstimatedDuration | WorkOrder->AutoCalculateEstimatedDuration | boolean | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| contactDescription | WorkOrder->ContactDescription | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| costCentreCode | WorkOrder->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrder->CostCentre_Description | string | |\r\n| description | WorkOrder->Description | string | |\r\n| duration | WorkOrder->Duration | string | duration |\r\n| email | WorkOrder->Email | string | email |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| eventCode | WorkOrder->Event_Code | string | |\r\n| eventDescription | WorkOrder->Event_Description | string | |\r\n| failedComponentId | WorkOrder->FailedComponent_Id | integer | int64 |\r\n| failedComponentCode | WorkOrder->FailedComponent_Code | string | |\r\n| failedComponentDescription | WorkOrder->FailedComponent_Description | string | |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | WorkOrder->FailureCause_Code | string | |\r\n| failureCauseDescription | WorkOrder->FailureCause_Description | string | |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | WorkOrder->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | WorkOrder->FailureCauseType_Description | string | |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | WorkOrder->FailureMechanism_Code | string | |\r\n| failureMechanismDescription | WorkOrder->FailureMechanism_Description | string | |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | WorkOrder->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | WorkOrder->FailureMechanismType_Description | string | |\r\n| failureModeId | WorkOrder->FailureMode_Id | integer | int64 |\r\n| failureModeCode | WorkOrder->FailureMode_Code | string | |\r\n| failureModeDescription | WorkOrder->FailureMode_Description | string | |\r\n| failureModeTypeId | WorkOrder->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | WorkOrder->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | WorkOrder->FailureModeType_Description | string | |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | WorkOrder->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrder->GeneralLedger_Description | string | |\r\n| hasServiceLevelAgreement | WorkOrder->HasServiceLevelAgreement | boolean | |\r\n| intervalId | WorkOrder->Interval_Id | integer | int64 |\r\n| intervalCode | WorkOrder->Interval_Code | string | |\r\n| intervalDescription | WorkOrder->Interval_Description | string | |\r\n| isFailure | WorkOrder->IsFailure | boolean | |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| latestWorkOrderProgressLogId | WorkOrder->LatestWorkOrderProgressLog_Id | integer | int64 |\r\n| latestWorkOrderProgressLogProgressEventId | WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Id | integer | int64 |\r\n| latestWorkOrderProgressLogProgressEventCode | WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Code | string | |\r\n| latestWorkOrderProgressLogProgressEventDescription | WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Description | string | |\r\n| latestWorkOrderProgressLogExecutedOn | WorkOrder->LatestWorkOrderProgressLog_ExecutedOn | string | date-time |\r\n| latestWorkOrderStatusChangeId | WorkOrder->LatestWorkOrderStatusChange_Id | integer | int64 |\r\n| latestWorkOrderStatusChangeRemark | WorkOrder->LatestWorkOrderStatusChange_Remark | string | |\r\n| locationId | WorkOrder->Location_Id | integer | int64 |\r\n| locationCode | WorkOrder->Location_Code | string | |\r\n| locationDescription | WorkOrder->Location_Description | string | |\r\n| mainScheduledReading | WorkOrder->MainScheduledReading | number | decimal |\r\n| mainServiceLevelAgreementId | WorkOrder->MainServiceLevelAgreement_Id | integer | int64 |\r\n| mainServiceLevelAgreementServiceLevelAgreementId | WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Id | integer | int64 |\r\n| mainServiceLevelAgreementServiceLevelAgreementCode | WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Code | string | |\r\n| mainServiceLevelAgreementServiceLevelAgreementDescription | WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Description | string | |\r\n| mainServiceLevelAgreementMainMeasurePercentage | WorkOrder->MainServiceLevelAgreement_MainMeasurePercentage | number | decimal |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkOrder->Notes | string | |\r\n| origin | WorkOrder->Origin | string (Allowed values: [Scheduled, Manual, Alarm, FollowUp]) | enum |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| parentWorkOrderCode | WorkOrder->ParentWorkOrder_Code | string | |\r\n| parentWorkOrderDescription | WorkOrder->ParentWorkOrder_Description | string | |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone1TypeCode | WorkOrder->Phone1Type_Code | string | |\r\n| phone1TypeDescription | WorkOrder->Phone1Type_Description | string | |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| phone2TypeCode | WorkOrder->Phone2Type_Code | string | |\r\n| phone2TypeDescription | WorkOrder->Phone2Type_Description | string | |\r\n| priority | WorkOrder->Priority | number | decimal |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| repairTypeCode | WorkOrder->RepairType_Code | string | |\r\n| repairTypeDescription | WorkOrder->RepairType_Description | string | |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| scheduledMeters | WorkOrder->ScheduledMeters | string | |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrder->Section_Code | string | |\r\n| sectionDescription | WorkOrder->Section_Description | string | |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| staffMemberCode | WorkOrder->StaffMember_Code | string | |\r\n| staffMemberResourceType | WorkOrder->StaffMember_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| staffMemberContactDetailId | WorkOrder->StaffMember_ContactDetailId | integer | int64 |\r\n| staffMemberContactDetailFirstName | WorkOrder->StaffMember_ContactDetailFirstName | string | |\r\n| staffMemberContactDetailFullName | WorkOrder->StaffMember_ContactDetailFullName | string | |\r\n| staffMemberContactDetailLastName | WorkOrder->StaffMember_ContactDetailLastName | string | |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| statusId | WorkOrder->Status_Id | integer | int64 |\r\n| statusCode | WorkOrder->Status_Code | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| statusDescription | WorkOrder->Status_Description | string | |\r\n| statusSequenceNumber | WorkOrder->Status_SequenceNumber | integer | int32 |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | WorkOrder->TaskClassification1_Code | string | |\r\n| taskClassification1Description | WorkOrder->TaskClassification1_Description | string | |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | WorkOrder->TaskClassification2_Code | string | |\r\n| taskClassification2Description | WorkOrder->TaskClassification2_Description | string | |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | WorkOrder->TaskClassification3_Code | string | |\r\n| taskClassification3Description | WorkOrder->TaskClassification3_Description | string | |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | WorkOrder->TaskClassification4_Code | string | |\r\n| taskClassification4Description | WorkOrder->TaskClassification4_Description | string | |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | WorkOrder->TaskClassification5_Code | string | |\r\n| taskClassification5Description | WorkOrder->TaskClassification5_Description | string | |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | WorkOrder->TaskClassification6_Code | string | |\r\n| taskClassification6Description | WorkOrder->TaskClassification6_Description | string | |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | WorkOrder->TaskClassification7_Code | string | |\r\n| taskClassification7Description | WorkOrder->TaskClassification7_Description | string | |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | WorkOrder->TaskClassification8_Code | string | |\r\n| taskClassification8Description | WorkOrder->TaskClassification8_Description | string | |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| tradeCode | WorkOrder->Trade_Code | string | |\r\n| tradeDescription | WorkOrder->Trade_Description | string | |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | WorkOrder->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | WorkOrder->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| useGlobalLookupLists | WorkOrder->UseGlobalLookupLists | boolean | |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification1Code | WorkOrder->WorkClassification1_Code | string | |\r\n| workClassification1Description | WorkOrder->WorkClassification1_Description | string | |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification2Code | WorkOrder->WorkClassification2_Code | string | |\r\n| workClassification2Description | WorkOrder->WorkClassification2_Description | string | |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification3Code | WorkOrder->WorkClassification3_Code | string | |\r\n| workClassification3Description | WorkOrder->WorkClassification3_Description | string | |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification4Code | WorkOrder->WorkClassification4_Code | string | |\r\n| workClassification4Description | WorkOrder->WorkClassification4_Description | string | |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| workClassification5Code | WorkOrder->WorkClassification5_Code | string | |\r\n| workClassification5Description | WorkOrder->WorkClassification5_Description | string | |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| workOrderImportanceCode | WorkOrder->WorkOrderImportance_Code | string | |\r\n| workOrderImportanceDescription | WorkOrder->WorkOrderImportance_Description | string | |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n", "operationId": "BatchGetWorkOrder", "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 Work Order 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 Work Order collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Batch": { "post": { "tags": [ "Work Order" ], "summary": "Create a new collection of Work Order 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| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| permissionTreeId | WorkOrder->PermissionTree_Id | integer | int64 |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| autoCalculateEstimatedDowntime | WorkOrder->AutoCalculateEstimatedDowntime | boolean | |\r\n| autoCalculateEstimatedDuration | WorkOrder->AutoCalculateEstimatedDuration | boolean | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| contactDescription | WorkOrder->ContactDescription | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| duration | WorkOrder->Duration | string | duration |\r\n| email | WorkOrder->Email | string | email |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| failedComponentId | WorkOrder->FailedComponent_Id | integer | int64 |\r\n| analysisComponentId | WorkOrder->AnalysisComponent_Id | integer | int64 |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureModeId | WorkOrder->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | WorkOrder->FailureModeType_Id | integer | int64 |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | WorkOrder->Requester | string | |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| useGlobalLookupLists | WorkOrder->UseGlobalLookupLists | boolean | |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n| notes | WorkOrder->Notes | string | |\r\n| geographicLocation | WorkOrder->GeographicLocation | object | |\r\n| geographicStartPosition | WorkOrder->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkOrder->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkOrder->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrder->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkOrder->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkOrder->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkOrder->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Min Value | > 1| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| duration | Min Value | >= 00:00:00| |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| estimatedDowntime | Nullable | False | |\r\n| estimatedDowntime | Min Value | >= 00:00:00| |\r\n| estimatedDuration | Nullable | False | |\r\n| estimatedDuration | Min Value | >= 00:00:00| |\r\n| failedComponentId | Nullable | True | WorkOrder->Asset_Id eq NULL |\r\n| failureCauseTypeId | Nullable | False | WorkOrder->FailureCause_Id ne NULL |\r\n| failureMechanismTypeId | Nullable | False | WorkOrder->FailureMechanism_Id ne NULL |\r\n| failureModeTypeId | Nullable | False | WorkOrder->FailureMode_Id ne NULL |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| isPermitRequired | Nullable | False | |\r\n| requesterContactId | Nullable | True | WorkOrder->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkOrder->RequesterType eq 'Contact' |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| progressPercentage | Min Value | >= 0| |\r\n| receivedOn | Nullable | False | |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requester | Nullable | False | WorkOrder->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkOrder->RequesterType eq 'FreeText' |\r\n| requiredBy | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| useGlobalLookupLists | Nullable | False | |\r\n| workRequired | Required | True | |\r\n| workRequired | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrder", "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/BatchCreateWorkOrderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order" ], "summary": "Update a collection of existing Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| version | WorkOrder->Version | integer | int32 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| alarmId | WorkOrder->Alarm_Id | integer | int64 |\r\n| assetModificationApproved | WorkOrder->AssetModificationApproved | boolean | |\r\n| assetModificationInvestigated | WorkOrder->AssetModificationInvestigated | boolean | |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| autoCalculateEstimatedDowntime | WorkOrder->AutoCalculateEstimatedDowntime | boolean | |\r\n| autoCalculateEstimatedDuration | WorkOrder->AutoCalculateEstimatedDuration | boolean | |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| contactDescription | WorkOrder->ContactDescription | string | |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| email | WorkOrder->Email | string | email |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| failedComponentId | WorkOrder->FailedComponent_Id | integer | int64 |\r\n| analysisComponentId | WorkOrder->AnalysisComponent_Id | integer | int64 |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureModeId | WorkOrder->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | WorkOrder->FailureModeType_Id | integer | int64 |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| requester | WorkOrder->Requester | string | |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| useGlobalLookupLists | WorkOrder->UseGlobalLookupLists | boolean | |\r\n| workStartedOn | WorkOrder->WorkStartedOn | string | date-time |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| priority | WorkOrder->Priority | number | decimal |\r\n| notes | WorkOrder->Notes | string | |\r\n| geographicLocation | WorkOrder->GeographicLocation | object | |\r\n| geographicStartPosition | WorkOrder->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkOrder->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkOrder->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrder->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkOrder->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkOrder->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkOrder->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| 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| siteId | Nullable | False | |\r\n| assetId | Min Value | > 1| |\r\n| assetModificationApproved | Nullable | False | |\r\n| assetModificationInvestigated | Nullable | False | |\r\n| costCentreId | Nullable | False | |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| estimatedDowntime | Nullable | False | |\r\n| estimatedDowntime | Min Value | >= 00:00:00| |\r\n| estimatedDuration | Nullable | False | |\r\n| estimatedDuration | Min Value | >= 00:00:00| |\r\n| failedComponentId | Nullable | True | WorkOrder->Asset_Id eq NULL |\r\n| failureCauseTypeId | Nullable | False | WorkOrder->FailureCause_Id ne NULL |\r\n| failureMechanismTypeId | Nullable | False | WorkOrder->FailureMechanism_Id ne NULL |\r\n| failureModeTypeId | Nullable | False | WorkOrder->FailureMode_Id ne NULL |\r\n| generalLedgerId | Nullable | False | |\r\n| isPermitRequired | Nullable | False | |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| progressPercentage | Min Value | >= 0| |\r\n| receivedOn | Nullable | False | |\r\n| requesterContactId | Nullable | True | WorkOrder->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkOrder->RequesterType eq 'Contact' |\r\n| requester | Nullable | False | WorkOrder->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkOrder->RequesterType eq 'FreeText' |\r\n| requiredBy | Nullable | False | |\r\n| useGlobalLookupLists | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| workRequired | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrder", "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/BatchUpdateWorkOrderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/Requisition/Batch": { "patch": { "tags": [ "Work Order" ], "summary": "Update a collection of existing Work Order 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 | Requisition->Id | integer | int64 |\r\n| version | Requisition->Version | integer | int32 |\r\n| code | Requisition->Code | string | |\r\n| notes | Requisition->Notes | string | |\r\n| importanceId | Requisition->Importance_Id | integer | int64 |\r\n| requestTypeId | Requisition->RequestType_Id | integer | int64 |\r\n| requestedOn | Requisition->RequestedOn | string | date-time |\r\n| requester | Requisition->Requester | string | |\r\n| requesterContactId | Requisition->RequesterContact_Id | integer | int64 |\r\n| requesterType | Requisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| sequenceNumber | Requisition->SequenceNumber | integer | int32 |\r\n| workOrderId | Requisition->WorkOrder_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | Requisition->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| |\r\n| requesterContactId | Nullable | True | Requisition->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | Requisition->RequesterType eq 'Contact' |\r\n| requesterType | Nullable | False | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderRequisition", "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/BatchUpdateWorkOrderRequisitionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/{id}/AddSpareToNewRequisition": { "post": { "tags": [ "Work Order" ], "summary": "Generate a Requisition for the Work Order 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 | AddSpareToNewRequisition->Code | string | |\r\n| permissionTreeId | AddSpareToNewRequisition->PermissionTree_Id | integer | int64 |\r\n| requesterType | AddSpareToNewRequisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | AddSpareToNewRequisition->Requester | string | |\r\n| requesterContactId | AddSpareToNewRequisition->RequesterContact_Id | integer | int64 |\r\n| requestedOn | AddSpareToNewRequisition->RequestedOn | string | date-time |\r\n| sequenceNumber | AddSpareToNewRequisition->SequenceNumber | integer | int32 |\r\n| notes | AddSpareToNewRequisition->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 | System Generated | true | If no value specified |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requestedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "AddSpareToNewRequisitionForWorkOrder", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/AddSpareToNewRequisitionForWorkResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/AddSpareToRequisition": { "post": { "tags": [ "Work Order" ], "summary": "Add the Work Order Task Spare for the Work Order to the specified Requisition.", "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| requisitionId | AddSpareToRequisition->Requisition_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| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n\r\n", "operationId": "AddSpareToRequisitionForWorkOrder", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/AddSpareToRequisitionForWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/AlignTasks": { "post": { "tags": [ "Work Order" ], "summary": "Complete All Tasks on the Work Order.", "description": "", "operationId": "AlignWorkOrderTasksWithAssetTasks", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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/WM/WorkOrders/Batch/AddSpareToNewRequisition": { "post": { "tags": [ "Work Order" ], "summary": "Generate Requisitions for a collection of Work Order 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| entityIds | AddSpareToNewRequisition->EntityIds | array | array |\r\n| permissionTreeId | AddSpareToNewRequisition->PermissionTree_Id | integer | int64 |\r\n| requesterType | AddSpareToNewRequisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | AddSpareToNewRequisition->Requester | string | |\r\n| requesterContactId | AddSpareToNewRequisition->RequesterContact_Id | integer | int64 |\r\n| requestedOn | AddSpareToNewRequisition->RequestedOn | string | date-time |\r\n| notes | AddSpareToNewRequisition->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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requestedOn | Required | True | |\r\n| requestedOn | Nullable | False | |\r\n\r\n", "operationId": "BatchAddSpareToNewRequisitionForWorkOrder", "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/BatchAddSpareToNewRequisitionForWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/AlignTasks/Batch": { "post": { "tags": [ "Work Order" ], "summary": "Align Work Order Tasks with Asset Tasks for a collection of Work Order 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 | AlignWorkOrderTasksWithAssetTasks->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\r\n", "operationId": "BatchAlignWorkOrderTasksWithAssetTasks", "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/BatchAlignWorkOrderTasksWithAssetTasksResourceActionRequest" } }, { "$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/WM/WorkOrders/CompleteAllTasks/Batch": { "post": { "tags": [ "Work Order" ], "summary": "Complete All Tasks for a collection of Work Order 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| workOrderIds | CompleteAllTasksForWorkOrders->WorkOrderIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "BatchCompleteAllTasks", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "workOrders", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCompleteAllTasksResourceActionRequest" } }, { "$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/WM/WorkOrders/Batch/IssueAll": { "post": { "tags": [ "Work Order" ], "summary": "Issue all Items for collection of Work Order 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| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchIssueAllWorkOrder", "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/BatchIssueAllWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/Batch/ReturnAll": { "post": { "tags": [ "Work Order" ], "summary": "Return all Items for collection of Work Order 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| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchReturnAllWorkOrder", "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/BatchReturnAllWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/CalculatePriorities": { "post": { "tags": [ "Work Order" ], "summary": "Calculate Work Order Priority", "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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "CalculateWorkOrderPriority", "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/CalculateWorkOrderPriorityResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/PermissionTree": { "patch": { "tags": [ "Work Order" ], "summary": "Change the PermissionTree for an existing Work Order 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 | WorkOrder->Version | integer | int32 |\r\n| permissionTreeId | WorkOrder->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": "ChangeWorkOrderPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/CompleteAllTasks": { "patch": { "tags": [ "Work Order" ], "summary": "Complete All Tasks on the Work Order.", "description": "", "operationId": "CompleteAllTasks", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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/WM/WorkOrders/ServiceLevelAgreements/ForceProgressCalculation": { "post": { "tags": [ "Work Order" ], "summary": "Force WorkOrder Service Level Agreement ProgressCalculation", "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| workOrderIds | ForceWorkOrderServiceLevelAgreementProgressCalculation->WorkOrderIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "ForceWorkOrderServiceLevelAgreementProgressCalculation", "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/ForceWorkOrderServiceLevelAgreementProgressCalculationResourceActionRequest" } }, { "$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/WM/WorkOrders/ServiceLevelAgreements/ForceReassign": { "post": { "tags": [ "Work Order" ], "summary": "Force WorkOrder Service Level Agreement Reassignment", "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| workOrderIds | ForceWorkOrderServiceLevelAgreementReassignment->WorkOrderIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "ForceWorkOrderServiceLevelAgreementReassignment", "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/ForceWorkOrderServiceLevelAgreementReassignmentResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/IssueAll": { "post": { "tags": [ "Work Order" ], "summary": "Issue all Items for Work Order 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| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "IssueAllWorkOrder", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/IssueAllWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/ReturnAll": { "post": { "tags": [ "Work Order" ], "summary": "Return all Items for Work Order 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| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "ReturnAllWorkOrder", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ReturnAllWorkOrderResourceActionRequest" } }, { "$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/WM/WorkOrders/{id}/SetProgress/{code}": { "post": { "tags": [ "Work Order" ], "summary": "Generate a Work Order Progress Log for the Work Order 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| executedOn | WorkOrderSetProgress->ExecutedOn | string | date-time |\r\n| freeTextReason | WorkOrderSetProgress->FreeTextReason | string | |\r\n| reasonId | WorkOrderSetProgress->Reason_Id | integer | int64 |\r\n| geographicLocation | WorkOrderSetProgress->GeographicLocation | object | |\r\n| geographicStartPosition | WorkOrderSetProgress->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkOrderSetProgress->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkOrderSetProgress->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrderSetProgress->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkOrderSetProgress->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkOrderSetProgress->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkOrderSetProgress->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "WorkOrderSetProgress", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "code", "in": "path", "required": true, "description": "Resource property to use as value", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/WorkOrderSetProgressResourceActionRequest" } }, { "$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/WM/WorkOrders/Status": { "post": { "tags": [ "Work Order" ], "summary": "Change the status for the Work Order 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| workOrderId | WorkOrderStatusChange->WorkOrder_Id | integer | int64 |\r\n| version | WorkOrderStatusChange->Version | integer | int32 |\r\n| statusId | WorkOrderStatusChange->Status_Id | integer | int64 |\r\n| offlineStatusChangedOn | WorkOrderStatusChange->OfflineStatusChangedOn | string | date-time |\r\n| remark | WorkOrderStatusChange->Remark | 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| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| statusId | Required | True | |\r\n| statusId | Nullable | False | |\r\n\r\n", "operationId": "ChangeWorkOrderStatus", "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/ChangeWorkOrderStatusResourceActionRequest" } }, { "$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/WM/WorkOrders/Merge/Batch": { "post": { "tags": [ "Work Order" ], "summary": "Merge a collection of Work Order resources together", "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| targetWorkOrderId | WorkOrderMerge->TargetWorkOrderId | integer | int64 |\r\n| sourceWorkOrderIds | WorkOrderMerge->SourceWorkOrderIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| targetWorkOrderId | Required | True | |\r\n| targetWorkOrderId | Nullable | False | |\r\n| sourceWorkOrderIds | Required | True | |\r\n| sourceWorkOrderIds | Nullable | False | |\r\n\r\n", "operationId": "BatchMergeWorkOrders", "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/BatchWorkOrderMergeResourceActionRequest" } }, { "$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/WM/WorkOrders/Merge": { "post": { "tags": [ "Work Order" ], "summary": "Merge several Work Order resources together.", "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| targetWorkOrderId | WorkOrderMerge->TargetWorkOrderId | integer | int64 |\r\n| sourceWorkOrderIds | WorkOrderMerge->SourceWorkOrderIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| targetWorkOrderId | Required | True | |\r\n| targetWorkOrderId | Nullable | False | |\r\n| sourceWorkOrderIds | Required | True | |\r\n| sourceWorkOrderIds | Nullable | False | |\r\n\r\n", "operationId": "MergeWorkOrders", "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/WorkOrderMergeResourceActionRequest" } }, { "$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/WM/WorkOrders/Split": { "post": { "tags": [ "Work Order" ], "summary": "Split the Work Order Task resources for a Work Order into separate Work Order 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| sourceWorkOrderId | WorkOrderSplit->SourceWorkOrderId | integer | int64 |\r\n| targetWorkOrderTaskIds | WorkOrderSplit->TargetWorkOrderTaskIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| sourceWorkOrderId | Required | True | |\r\n| sourceWorkOrderId | Nullable | False | |\r\n| targetWorkOrderTaskIds | Required | True | |\r\n| targetWorkOrderTaskIds | Nullable | False | |\r\n\r\n", "operationId": "SplitWorkOrders", "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/WorkOrderSplitResourceActionRequest" } }, { "$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/WM/WorkOrders/Batch/PermissionTree": { "patch": { "tags": [ "Work Order" ], "summary": "Change the PermissionTree status for a collection of existing Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| version | WorkOrder->Version | integer | int32 |\r\n| permissionTreeId | WorkOrder->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": "BatchChangeWorkOrderPermissionTree", "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/BatchChangeWorkOrderPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Status/Batch": { "post": { "tags": [ "Work Order" ], "summary": "Change the status for a collection of Work Order 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| workOrderId | WorkOrderStatusChange->WorkOrder_Id | integer | int64 |\r\n| version | WorkOrderStatusChange->Version | integer | int32 |\r\n| statusId | WorkOrderStatusChange->Status_Id | integer | int64 |\r\n| offlineStatusChangedOn | WorkOrderStatusChange->OfflineStatusChangedOn | string | date-time |\r\n| remark | WorkOrderStatusChange->Remark | 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| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| statusId | Required | True | |\r\n| statusId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeWorkOrderStatus", "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/BatchChangeWorkOrderStatusResourceActionRequest" } }, { "$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/WM/WorkOrders/Split/Batch": { "post": { "tags": [ "Work Order" ], "summary": "Split the Work Order Task resources for a collection of Work Order resources into separate Work Order 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| sourceWorkOrderId | WorkOrderSplit->SourceWorkOrderId | integer | int64 |\r\n| targetWorkOrderTaskIds | WorkOrderSplit->TargetWorkOrderTaskIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| sourceWorkOrderId | Required | True | |\r\n| sourceWorkOrderId | Nullable | False | |\r\n| targetWorkOrderTaskIds | Required | True | |\r\n| targetWorkOrderTaskIds | Nullable | False | |\r\n\r\n", "operationId": "BatchSplitWorkOrders", "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/BatchWorkOrderSplitResourceActionRequest" } }, { "$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/WM/WorkOrders/MatchBatch": { "patch": { "tags": [ "Work Order" ], "summary": "Update a collection of existing Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| version | WorkOrder->Version | integer | int32 |\r\n| workRequired | WorkOrder->WorkRequired | string | |\r\n| workPerformed | WorkOrder->WorkPerformed | string | |\r\n| requesterType | WorkOrder->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requesterContactId | WorkOrder->RequesterContact_Id | integer | int64 |\r\n| requester | WorkOrder->Requester | string | |\r\n| phone1 | WorkOrder->Phone1 | string | phone |\r\n| phone2 | WorkOrder->Phone2 | string | phone |\r\n| phone1TypeId | WorkOrder->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkOrder->Phone2Type_Id | integer | int64 |\r\n| email | WorkOrder->Email | string | email |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| parentWorkOrderId | WorkOrder->ParentWorkOrder_Id | integer | int64 |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| workOrderImportanceId | WorkOrder->WorkOrderImportance_Id | integer | int64 |\r\n| isPermitRequired | WorkOrder->IsPermitRequired | boolean | |\r\n| eventId | WorkOrder->Event_Id | integer | int64 |\r\n| startOn | WorkOrder->StartOn | string | date-time |\r\n| completeBy | WorkOrder->CompleteBy | string | date-time |\r\n| estimatedDuration | WorkOrder->EstimatedDuration | string | duration |\r\n| estimatedDowntime | WorkOrder->EstimatedDowntime | string | duration |\r\n| motionType | WorkOrder->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| sectionId | WorkOrder->Section_Id | integer | int64 |\r\n| tradeId | WorkOrder->Trade_Id | integer | int64 |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| generalLedgerId | WorkOrder->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | WorkOrder->CostCentre_Id | integer | int64 |\r\n| completedOn | WorkOrder->CompletedOn | string | date-time |\r\n| progressPercentage | WorkOrder->ProgressPercentage | number | decimal |\r\n| permitNumber | WorkOrder->PermitNumber | string | |\r\n| failureMechanismTypeId | WorkOrder->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismId | WorkOrder->FailureMechanism_Id | integer | int64 |\r\n| failureCauseTypeId | WorkOrder->FailureCauseType_Id | integer | int64 |\r\n| failureCauseId | WorkOrder->FailureCause_Id | integer | int64 |\r\n| repairTypeId | WorkOrder->RepairType_Id | integer | int64 |\r\n| workClassification1Id | WorkOrder->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | WorkOrder->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | WorkOrder->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | WorkOrder->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | WorkOrder->WorkClassification5_Id | integer | int64 |\r\n| taskClassification1Id | WorkOrder->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | WorkOrder->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | WorkOrder->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | WorkOrder->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | WorkOrder->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | WorkOrder->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | WorkOrder->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | WorkOrder->TaskClassification8_Id | integer | int64 |\r\n| assetModificationApproved | WorkOrder->AssetModificationApproved | boolean | |\r\n| assetModificationInvestigated | WorkOrder->AssetModificationInvestigated | boolean | |\r\n| assetModificationProposalNumber | WorkOrder->AssetModificationProposalNumber | string | |\r\n| priority | WorkOrder->Priority | number | decimal |\r\n| notes | WorkOrder->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| workRequired | Nullable | False | |\r\n| requesterContactId | Nullable | True | WorkOrder->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkOrder->RequesterType eq 'Contact' |\r\n| requester | Nullable | False | WorkOrder->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkOrder->RequesterType eq 'FreeText' |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| receivedOn | Nullable | False | |\r\n| requiredBy | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| isPermitRequired | Nullable | False | |\r\n| estimatedDuration | Nullable | False | |\r\n| estimatedDuration | Min Value | >= 00:00:00| |\r\n| estimatedDowntime | Nullable | False | |\r\n| estimatedDowntime | Min Value | >= 00:00:00| |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Nullable | False | |\r\n| progressPercentage | Min Value | >= 0| |\r\n| failureMechanismTypeId | Nullable | False | WorkOrder->FailureMechanism_Id ne NULL |\r\n| failureCauseTypeId | Nullable | False | WorkOrder->FailureCause_Id ne NULL |\r\n| assetModificationApproved | Nullable | False | |\r\n| assetModificationInvestigated | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateWorkOrder", "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/MatchUpdateWorkOrderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/Attributes/{id}": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Get a Work Order 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| workOrderId | WorkOrderAttribute->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderAttribute->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderAttribute->WorkOrder_Description | string | |\r\n| createdByUserId | WorkOrderAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderAttribute->CreatedOn | string | date-time |\r\n| isActive | WorkOrderAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderAttribute->PermissionTree_Description | string | |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| id | WorkOrderAttribute->Id | integer | int64 |\r\n| attributeId | WorkOrderAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WorkOrderAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WorkOrderAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WorkOrderAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WorkOrderAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WorkOrderAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WorkOrderAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WorkOrderAttribute->Notes | string | |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n", "operationId": "GetWorkOrderAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Attribute", "schema": { "$ref": "#/definitions/GetWorkOrderAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Attribute" ], "summary": "Update an existing Work Order 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 | WorkOrderAttribute->Version | integer | int32 |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderAttribute->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": "UpdateWorkOrderAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order Attribute" ], "summary": "Delete an existing Work Order 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 | WorkOrderAttribute->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": "DeleteWorkOrderAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/{workOrderId}/Attributes": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Get a collection of Work Order Attribute resources for the Work Order.", "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 | WorkOrderAttribute->Id | integer | int64 |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WorkOrderAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderAttribute->Attribute_Description | string | |\r\n| attributeDataType | WorkOrderAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderAttribute->PredefinedValue_Value | object | composite |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n| notes | WorkOrderAttribute->Notes | string | |\r\n| createdOn | WorkOrderAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderAttributeCollectionForWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Attribute collection", "schema": { "$ref": "#/definitions/GetWorkOrderAttributeCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Get a collection of Work Order 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 | WorkOrderAttribute->Id | integer | int64 |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| workOrderId | WorkOrderAttribute->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderAttribute->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderAttribute->WorkOrder_Description | string | |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WorkOrderAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderAttribute->Attribute_Description | string | |\r\n| attributeDataType | WorkOrderAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderAttribute->PredefinedValue_Value | object | composite |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n| notes | WorkOrderAttribute->Notes | string | |\r\n| createdOn | WorkOrderAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderAttributeCollection", "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 Work Order Attribute collection", "schema": { "$ref": "#/definitions/GetWorkOrderAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Attribute" ], "summary": "Create a new Work Order 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| workOrderId | WorkOrderAttribute->WorkOrder_Id | integer | int64 |\r\n| attributeId | WorkOrderAttribute->Attribute_Id | integer | int64 |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderAttribute->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| workOrderId | Required | True | |\r\n| workOrderId | 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": "CreateWorkOrderAttribute", "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/CreateWorkOrderAttributeResourceActionRequest" } }, { "$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/WM/WorkOrders/Attributes/Lookups/LookupWorkOrderAttributeAllowedValue": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Work Order 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": "LookupWorkOrderAttributeAllowedValue", "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/WorkOrderAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes/Lookups/LookupWorkOrderAttribute": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Work Order 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": "LookupWorkOrderAttribute", "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/WorkOrderAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes/Lookups/LookupWorkOrderAttributeChangePermissionTree": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Lookup the permission set for changing the Work Order 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": "LookupWorkOrderAttributeChangePermissionTree", "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/WorkOrderAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes/Lookups/LookupWorkOrderAttributeInsertPermissionTree": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Lookup the permission set for creating the Work Order 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": "LookupWorkOrderAttributeInsertPermissionTree", "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/WorkOrderAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes/Lookups/LookupWorkOrderAttributeWorkOrder": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Lookup the Work Order Attribute for the Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupWorkOrderAttributeWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderAttributeWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes/Batch/{ids}": { "get": { "tags": [ "Work Order Attribute" ], "summary": "Get a collection of Work Order 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| workOrderId | WorkOrderAttribute->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderAttribute->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderAttribute->WorkOrder_Description | string | |\r\n| createdByUserId | WorkOrderAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderAttribute->CreatedOn | string | date-time |\r\n| isActive | WorkOrderAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderAttribute->PermissionTree_Description | string | |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| id | WorkOrderAttribute->Id | integer | int64 |\r\n| attributeId | WorkOrderAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WorkOrderAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WorkOrderAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WorkOrderAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WorkOrderAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WorkOrderAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WorkOrderAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WorkOrderAttribute->Notes | string | |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n", "operationId": "BatchGetWorkOrderAttribute", "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 Work Order 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 Work Order Attribute collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Attributes/Batch": { "post": { "tags": [ "Work Order Attribute" ], "summary": "Create a new collection of Work Order 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| workOrderId | WorkOrderAttribute->WorkOrder_Id | integer | int64 |\r\n| attributeId | WorkOrderAttribute->Attribute_Id | integer | int64 |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderAttribute->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| workOrderId | Required | True | |\r\n| workOrderId | 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": "BatchCreateWorkOrderAttribute", "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/BatchCreateWorkOrderAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order Attribute" ], "summary": "Update a collection of existing Work Order 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 | WorkOrderAttribute->Id | integer | int64 |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| value | WorkOrderAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderAttribute->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": "BatchUpdateWorkOrderAttribute", "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/BatchUpdateWorkOrderAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order Attribute" ], "summary": "Delete a collection of existing Work Order 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 | WorkOrderAttribute->Id | integer | int64 |\r\n| version | WorkOrderAttribute->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": "BatchDeleteWorkOrderAttribute", "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/BatchDeleteWorkOrderAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/Attributes/{id}/Active": { "patch": { "tags": [ "Work Order Attribute" ], "summary": "Change the IsActive status for an existing Work Order 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 | WorkOrderAttribute->Version | integer | int32 |\r\n| isActive | WorkOrderAttribute->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": "ChangeWorkOrderAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderAttributeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Attribute" ], "summary": "Change the PermissionTree for an existing Work Order 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 | WorkOrderAttribute->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderAttribute->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": "ChangeWorkOrderAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderAttributePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Work Order 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 | WorkOrderAttribute->Id | integer | int64 |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderAttribute->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": "BatchChangeWorkOrderAttributePermissionTree", "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/BatchChangeWorkOrderAttributePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Attributes/Batch/Active": { "patch": { "tags": [ "Work Order Attribute" ], "summary": "Change the IsActive status for a collection of existing Work Order 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 | WorkOrderAttribute->Id | integer | int64 |\r\n| version | WorkOrderAttribute->Version | integer | int32 |\r\n| isActive | WorkOrderAttribute->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": "BatchChangeWorkOrderAttributeIsActive", "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/BatchChangeWorkOrderAttributeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/CompleteAllTasksLogs/{id}": { "get": { "tags": [ "Work Order Complete All Tasks Log" ], "summary": "Get a Work Order Complete All Tasks Log 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 | WorkOrderCompleteAllTasksLog->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderCompleteAllTasksLog->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderCompleteAllTasksLog->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderCompleteAllTasksLog->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderCompleteAllTasksLog->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderCompleteAllTasksLog->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderCompleteAllTasksLog->PermissionTree_Description | string | |\r\n| id | WorkOrderCompleteAllTasksLog->Id | integer | int64 |\r\n| version | WorkOrderCompleteAllTasksLog->Version | integer | int32 |\r\n| batchId | WorkOrderCompleteAllTasksLog->BatchId | integer | int64 |\r\n| result | WorkOrderCompleteAllTasksLog->Result | string | |\r\n| wasSuccessful | WorkOrderCompleteAllTasksLog->WasSuccessful | boolean | |\r\n| workOrderId | WorkOrderCompleteAllTasksLog->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderCompleteAllTasksLog->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderCompleteAllTasksLog->WorkOrder_Description | string | |\r\n| workOrderTaskId | WorkOrderCompleteAllTasksLog->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription | string | |\r\n", "operationId": "GetWorkOrderCompleteAllTasksLog", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Complete All Tasks Log Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Complete All Tasks Log", "schema": { "$ref": "#/definitions/GetWorkOrderCompleteAllTasksLogResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/CompleteAllTasksLogs": { "get": { "tags": [ "Work Order Complete All Tasks Log" ], "summary": "Get a collection of Work Order Complete All Tasks Log resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderCompleteAllTasksLog->Id | integer | int64 |\r\n| version | WorkOrderCompleteAllTasksLog->Version | integer | int32 |\r\n| batchId | WorkOrderCompleteAllTasksLog->BatchId | integer | int64 |\r\n| result | WorkOrderCompleteAllTasksLog->Result | string | |\r\n| wasSuccessful | WorkOrderCompleteAllTasksLog->WasSuccessful | boolean | |\r\n| workOrderId | WorkOrderCompleteAllTasksLog->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderCompleteAllTasksLog->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderCompleteAllTasksLog->WorkOrder_Description | string | |\r\n| workOrderTaskId | WorkOrderCompleteAllTasksLog->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription | string | |\r\n", "operationId": "GetWorkOrderCompleteAllTasksLogCollection", "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 Work Order Complete All Tasks Log collection", "schema": { "$ref": "#/definitions/GetWorkOrderCompleteAllTasksLogCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/CompleteAllTasksLogs/{batchId}/Logs": { "get": { "tags": [ "Work Order Complete All Tasks Log" ], "summary": "Get a collection of Work Order Complete All Tasks Log resources for the same batch id.", "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 | WorkOrderCompleteAllTasksLog->Id | integer | int64 |\r\n| version | WorkOrderCompleteAllTasksLog->Version | integer | int32 |\r\n| result | WorkOrderCompleteAllTasksLog->Result | string | |\r\n| wasSuccessful | WorkOrderCompleteAllTasksLog->WasSuccessful | boolean | |\r\n| workOrderId | WorkOrderCompleteAllTasksLog->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderCompleteAllTasksLog->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderCompleteAllTasksLog->WorkOrder_Description | string | |\r\n| workOrderTaskId | WorkOrderCompleteAllTasksLog->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription | string | |\r\n", "operationId": "GetWorkOrderCompleteAllTasksLogForBatchCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "batchId", "in": "path", "required": true, "description": "Resource property to use as value", "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 Work Order Complete All Tasks Log collection", "schema": { "$ref": "#/definitions/GetWorkOrderCompleteAllTasksLogForBatchCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/CompleteAllTasksLogs/Batch/{ids}": { "get": { "tags": [ "Work Order Complete All Tasks Log" ], "summary": "Get a collection of Work Order Complete All Tasks Log 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 | WorkOrderCompleteAllTasksLog->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderCompleteAllTasksLog->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderCompleteAllTasksLog->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderCompleteAllTasksLog->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderCompleteAllTasksLog->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderCompleteAllTasksLog->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderCompleteAllTasksLog->PermissionTree_Description | string | |\r\n| id | WorkOrderCompleteAllTasksLog->Id | integer | int64 |\r\n| version | WorkOrderCompleteAllTasksLog->Version | integer | int32 |\r\n| batchId | WorkOrderCompleteAllTasksLog->BatchId | integer | int64 |\r\n| result | WorkOrderCompleteAllTasksLog->Result | string | |\r\n| wasSuccessful | WorkOrderCompleteAllTasksLog->WasSuccessful | boolean | |\r\n| workOrderId | WorkOrderCompleteAllTasksLog->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderCompleteAllTasksLog->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderCompleteAllTasksLog->WorkOrder_Description | string | |\r\n| workOrderTaskId | WorkOrderCompleteAllTasksLog->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription | string | |\r\n", "operationId": "BatchGetWorkOrderCompleteAllTasksLog", "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 Work Order Complete All Tasks Log 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 Work Order Complete All Tasks Log collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderCompleteAllTasksLogResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents/{id}": { "get": { "tags": [ "Work Order Document" ], "summary": "Get a Work Order 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| isCopiedDocumentLink | WorkOrderDocument->IsCopiedDocumentLink | boolean | |\r\n| workOrderId | WorkOrderDocument->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderDocument->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderDocument->WorkOrder_Description | string | |\r\n| isActive | WorkOrderDocument->IsActive | boolean | |\r\n| createdByUserId | WorkOrderDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderDocument->ModifiedOn | string | date-time |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderDocument->PermissionTree_Description | string | |\r\n| id | WorkOrderDocument->Id | integer | int64 |\r\n| documentRecordId | WorkOrderDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkOrderDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkOrderDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkOrderDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkOrderDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkOrderDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkOrderDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkOrderDocument->Notes | string | |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWorkOrderDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Document", "schema": { "$ref": "#/definitions/GetWorkOrderDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Document" ], "summary": "Update an existing Work Order 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 | WorkOrderDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderDocument->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": "UpdateWorkOrderDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order Document" ], "summary": "Delete an existing Work Order 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 | WorkOrderDocument->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": "DeleteWorkOrderDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/{id}/Documents": { "get": { "tags": [ "Work Order Document" ], "summary": "Get a collection of Work Order Document resources for the Work Order.", "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 | WorkOrderDocument->Id | integer | int64 |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkOrderDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkOrderDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkOrderDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkOrderDocument->DocumentRecord_FileType_Extension | string | |\r\n| isCopiedDocumentLink | WorkOrderDocument->IsCopiedDocumentLink | boolean | |\r\n", "operationId": "GetWorkOrderDocumentCollectionForWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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 Work Order Document collection", "schema": { "$ref": "#/definitions/GetWorkOrderDocumentCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents": { "get": { "tags": [ "Work Order Document" ], "summary": "Get a collection of Work Order 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 | WorkOrderDocument->Id | integer | int64 |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| workOrderId | WorkOrderDocument->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderDocument->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderDocument->WorkOrder_Description | string | |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkOrderDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkOrderDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkOrderDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkOrderDocument->DocumentRecord_FileType_Extension | string | |\r\n| isCopiedDocumentLink | WorkOrderDocument->IsCopiedDocumentLink | boolean | |\r\n", "operationId": "GetWorkOrderDocumentCollection", "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 Work Order Document collection", "schema": { "$ref": "#/definitions/GetWorkOrderDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Document" ], "summary": "Create a new Work Order 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| workOrderId | WorkOrderDocument->WorkOrder_Id | integer | int64 |\r\n| documentRecordId | WorkOrderDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderDocument->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| workOrderId | Required | True | |\r\n| workOrderId | 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": "CreateWorkOrderDocument", "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/CreateWorkOrderDocumentResourceActionRequest" } }, { "$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/WM/WorkOrders/Documents/Lookups/LookupWorkOrderDocumentChangePermissionTree": { "get": { "tags": [ "Work Order Document" ], "summary": "Lookup the permission set for changing the Work Order 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": "LookupWorkOrderDocumentChangePermissionTree", "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/WorkOrderDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents/Lookups/LookupWorkOrderDocument": { "get": { "tags": [ "Work Order Document" ], "summary": "Work Order Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupWorkOrderDocument", "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/WorkOrderDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents/Lookups/LookupWorkOrderDocumentInsertPermissionTree": { "get": { "tags": [ "Work Order Document" ], "summary": "Lookup the permission set for creating the Work Order 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": "LookupWorkOrderDocumentInsertPermissionTree", "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/WorkOrderDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents/Lookups/LookupWorkOrderDocumentWorkOrder": { "get": { "tags": [ "Work Order Document" ], "summary": "Lookup the Work Order Document for the Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupWorkOrderDocumentWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderDocumentWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents/Batch/{ids}": { "get": { "tags": [ "Work Order Document" ], "summary": "Get a collection of Work Order 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| isCopiedDocumentLink | WorkOrderDocument->IsCopiedDocumentLink | boolean | |\r\n| workOrderId | WorkOrderDocument->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderDocument->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderDocument->WorkOrder_Description | string | |\r\n| isActive | WorkOrderDocument->IsActive | boolean | |\r\n| createdByUserId | WorkOrderDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderDocument->ModifiedOn | string | date-time |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderDocument->PermissionTree_Description | string | |\r\n| id | WorkOrderDocument->Id | integer | int64 |\r\n| documentRecordId | WorkOrderDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkOrderDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkOrderDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkOrderDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkOrderDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkOrderDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkOrderDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkOrderDocument->Notes | string | |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderDocument", "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 Work Order 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 Work Order Document collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Documents/Batch": { "post": { "tags": [ "Work Order Document" ], "summary": "Create a new collection of Work Order 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| workOrderId | WorkOrderDocument->WorkOrder_Id | integer | int64 |\r\n| documentRecordId | WorkOrderDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderDocument->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| workOrderId | Required | True | |\r\n| workOrderId | 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": "BatchCreateWorkOrderDocument", "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/BatchCreateWorkOrderDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order Document" ], "summary": "Update a collection of existing Work Order 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 | WorkOrderDocument->Id | integer | int64 |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderDocument->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": "BatchUpdateWorkOrderDocument", "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/BatchUpdateWorkOrderDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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": [ "Work Order Document" ], "summary": "Delete a collection of existing Work Order 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 | WorkOrderDocument->Id | integer | int64 |\r\n| version | WorkOrderDocument->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": "BatchDeleteWorkOrderDocument", "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/BatchDeleteWorkOrderDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/Documents/{id}/Active": { "patch": { "tags": [ "Work Order Document" ], "summary": "Change the IsActive status for an existing Work Order 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 | WorkOrderDocument->Version | integer | int32 |\r\n| isActive | WorkOrderDocument->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": "ChangeWorkOrderDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Document" ], "summary": "Change the PermissionTree for an existing Work Order 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 | WorkOrderDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDocument->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": "ChangeWorkOrderDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Document" ], "summary": "Change the PermissionTree status for a collection of existing Work Order 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 | WorkOrderDocument->Id | integer | int64 |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDocument->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": "BatchChangeWorkOrderDocumentPermissionTree", "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/BatchChangeWorkOrderDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Documents/Batch/Active": { "patch": { "tags": [ "Work Order Document" ], "summary": "Change the IsActive status for a collection of existing Work Order 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 | WorkOrderDocument->Id | integer | int64 |\r\n| version | WorkOrderDocument->Version | integer | int32 |\r\n| isActive | WorkOrderDocument->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": "BatchChangeWorkOrderDocumentIsActive", "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/BatchChangeWorkOrderDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/DowntimeLosses/{id}": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Get a Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderDowntimeLoss->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderDowntimeLoss->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderDowntimeLoss->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderDowntimeLoss->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderDowntimeLoss->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderDowntimeLoss->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderDowntimeLoss->ModifiedOn | string | date-time |\r\n| version | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDowntimeLoss->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderDowntimeLoss->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderDowntimeLoss->PermissionTree_Description | string | |\r\n| id | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| duration | WorkOrderDowntimeLoss->Duration | string | duration |\r\n| notes | WorkOrderDowntimeLoss->Notes | string | |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| timeLossReasonCode | WorkOrderDowntimeLoss->TimeLossReason_Code | string | |\r\n| timeLossReasonDescription | WorkOrderDowntimeLoss->TimeLossReason_Description | string | |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_Id | integer | int64 |\r\n| workOrderDescription | WorkOrderDowntimeLoss->WorkOrder_Description | string | |\r\n| workOrderCode | WorkOrderDowntimeLoss->WorkOrder_Code | string | |\r\n", "operationId": "GetWorkOrderDowntimeLoss", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Downtime Loss Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Downtime Loss", "schema": { "$ref": "#/definitions/GetWorkOrderDowntimeLossResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Downtime Loss" ], "summary": "Update an existing Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDowntimeLoss->PermissionTree_Id | integer | int64 |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_Id | integer | int64 |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| notes | WorkOrderDowntimeLoss->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| permissionTreeId | Nullable | False | |\r\n| workOrderId | Nullable | False | |\r\n| timeLossReasonId | Nullable | False | |\r\n| downFrom | Nullable | False | |\r\n| downTo | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderDowntimeLoss", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Downtime Loss Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderDowntimeLossResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Downtime Loss 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": [ "Work Order Downtime Loss" ], "summary": "Delete an existing Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->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": "DeleteWorkOrderDowntimeLoss", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Downtime Loss Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderDowntimeLossResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Downtime Loss 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/WM/WorkOrders/DowntimeLosses": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Get a collection of Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| id | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderDowntimeLoss->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderDowntimeLoss->WorkOrder_Description | string | |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| timeLossReasonCode | WorkOrderDowntimeLoss->TimeLossReason_Code | string | |\r\n| timeLossReasonDescription | WorkOrderDowntimeLoss->TimeLossReason_Description | string | |\r\n| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| duration | WorkOrderDowntimeLoss->Duration | string | duration |\r\n", "operationId": "GetWorkOrderDowntimeLossCollection", "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 Work Order Downtime Loss collection", "schema": { "$ref": "#/definitions/GetWorkOrderDowntimeLossCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Downtime Loss" ], "summary": "Create a new Work Order Downtime Loss 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| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| notes | WorkOrderDowntimeLoss->Notes | string | |\r\n| permissionTreeId | WorkOrderDowntimeLoss->PermissionTree_Id | integer | int64 |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_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| downFrom | Required | True | |\r\n| downFrom | Nullable | False | |\r\n| downTo | Required | True | |\r\n| downTo | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| timeLossReasonId | Required | True | |\r\n| timeLossReasonId | Nullable | False | |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderDowntimeLoss", "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/CreateWorkOrderDowntimeLossResourceActionRequest" } }, { "$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/WM/WorkOrders/{workOrderId}/DowntimeLosses": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Get a collection of Work Order Downtime Loss resources for the Work Order.", "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 | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| id | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| workOrderCode | WorkOrderDowntimeLoss->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderDowntimeLoss->WorkOrder_Description | string | |\r\n| timeLossReasonCode | WorkOrderDowntimeLoss->TimeLossReason_Code | string | |\r\n| timeLossReasonDescription | WorkOrderDowntimeLoss->TimeLossReason_Description | string | |\r\n| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| duration | WorkOrderDowntimeLoss->Duration | string | duration |\r\n", "operationId": "GetWorkOrderDowntimeLossForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Downtime Loss collection", "schema": { "$ref": "#/definitions/GetWorkOrderDowntimeLossForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/DowntimeLosses/Lookups/LookupWorkOrderDowntimeLossChangePermissionTree": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Lookup the permission set for changing the Work Order Downtime Loss.", "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": "LookupWorkOrderDowntimeLossChangePermissionTree", "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/WorkOrderDowntimeLossChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/DowntimeLosses/Lookups/LookupWorkOrderDowntimeLossInsertPermissionTree": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Lookup the permission set for creating the Work Order Downtime Loss.", "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": "LookupWorkOrderDowntimeLossInsertPermissionTree", "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/WorkOrderDowntimeLossInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/DowntimeLosses/Lookups/LookupWorkOrderDowntimeLossTimeLossReason": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Lookup up the Time Loss Reason for the Work Order Downtime Loss", "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 | TimeLossReason->Id | integer | int64 |\r\n| code | TimeLossReason->Code | string | |\r\n| description | TimeLossReason->Description | string | |\r\n", "operationId": "LookupWorkOrderDowntimeLossTimeLossReason", "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/WorkOrderDowntimeLossTimeLossReasonLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/DowntimeLosses/Lookups/LookupWorkOrderDowntimeLossWorkOrder": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Lookup up the Work Order for the Work Order Downtime Loss", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "LookupWorkOrderDowntimeLossWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderDowntimeLossWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/DowntimeLosses/Batch/{ids}": { "get": { "tags": [ "Work Order Downtime Loss" ], "summary": "Get a collection of Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderDowntimeLoss->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderDowntimeLoss->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderDowntimeLoss->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderDowntimeLoss->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderDowntimeLoss->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderDowntimeLoss->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderDowntimeLoss->ModifiedOn | string | date-time |\r\n| version | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDowntimeLoss->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderDowntimeLoss->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderDowntimeLoss->PermissionTree_Description | string | |\r\n| id | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| duration | WorkOrderDowntimeLoss->Duration | string | duration |\r\n| notes | WorkOrderDowntimeLoss->Notes | string | |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| timeLossReasonCode | WorkOrderDowntimeLoss->TimeLossReason_Code | string | |\r\n| timeLossReasonDescription | WorkOrderDowntimeLoss->TimeLossReason_Description | string | |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_Id | integer | int64 |\r\n| workOrderDescription | WorkOrderDowntimeLoss->WorkOrder_Description | string | |\r\n| workOrderCode | WorkOrderDowntimeLoss->WorkOrder_Code | string | |\r\n", "operationId": "BatchGetWorkOrderDowntimeLoss", "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 Work Order Downtime Loss 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 Work Order Downtime Loss collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderDowntimeLossResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/DowntimeLosses/Batch": { "post": { "tags": [ "Work Order Downtime Loss" ], "summary": "Create a new collection of Work Order Downtime Loss 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| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| notes | WorkOrderDowntimeLoss->Notes | string | |\r\n| permissionTreeId | WorkOrderDowntimeLoss->PermissionTree_Id | integer | int64 |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_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| downFrom | Required | True | |\r\n| downFrom | Nullable | False | |\r\n| downTo | Required | True | |\r\n| downTo | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| timeLossReasonId | Required | True | |\r\n| timeLossReasonId | Nullable | False | |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderDowntimeLoss", "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/BatchCreateWorkOrderDowntimeLossResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Downtime Loss 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": [ "Work Order Downtime Loss" ], "summary": "Update a collection of existing Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| version | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDowntimeLoss->PermissionTree_Id | integer | int64 |\r\n| workOrderId | WorkOrderDowntimeLoss->WorkOrder_Id | integer | int64 |\r\n| timeLossReasonId | WorkOrderDowntimeLoss->TimeLossReason_Id | integer | int64 |\r\n| downFrom | WorkOrderDowntimeLoss->DownFrom | string | date-time |\r\n| downTo | WorkOrderDowntimeLoss->DownTo | string | date-time |\r\n| notes | WorkOrderDowntimeLoss->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| permissionTreeId | Nullable | False | |\r\n| workOrderId | Nullable | False | |\r\n| timeLossReasonId | Nullable | False | |\r\n| downFrom | Nullable | False | |\r\n| downTo | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderDowntimeLoss", "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/BatchUpdateWorkOrderDowntimeLossResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Downtime Loss 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": [ "Work Order Downtime Loss" ], "summary": "Delete a collection of existing Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| version | WorkOrderDowntimeLoss->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": "BatchDeleteWorkOrderDowntimeLoss", "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/BatchDeleteWorkOrderDowntimeLossResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Downtime Loss 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/WM/WorkOrders/DowntimeLosses/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Downtime Loss" ], "summary": "Change the PermissionTree for an existing Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDowntimeLoss->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": "ChangeWorkOrderDowntimeLossPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Downtime Loss Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/DowntimeLosses/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Downtime Loss" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Downtime Loss 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 | WorkOrderDowntimeLoss->Id | integer | int64 |\r\n| version | WorkOrderDowntimeLoss->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderDowntimeLoss->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": "BatchChangeWorkOrderDowntimeLossPermissionTree", "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/BatchChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/FileAttachments/{id}/Download": { "get": { "tags": [ "Work Order File Attachment" ], "summary": "Download the content for a Work Order File Attachment resource.", "description": "", "operationId": "GetWorkOrderFileAttachmentContent", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of attachment content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/{id}": { "get": { "tags": [ "Work Order File Attachment" ], "summary": "Get a Work Order File Attachment 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| workOrderId | WorkOrderFileAttachment->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderFileAttachment->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderFileAttachment->WorkOrder_Description | string | |\r\n| createdByUserId | WorkOrderFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkOrderFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkOrderFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkOrderFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkOrderFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkOrderFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkOrderFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkOrderFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkOrderFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkOrderFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkOrderFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkOrderFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkOrderFileAttachment->FileFullName | string | |\r\n| fileName | WorkOrderFileAttachment->FileName | string | |\r\n| fileTypeId | WorkOrderFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkOrderFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| id | WorkOrderFileAttachment->Id | integer | int64 |\r\n| isActive | WorkOrderFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkOrderFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetWorkOrderFileAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order File Attachment", "schema": { "$ref": "#/definitions/GetWorkOrderFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order File Attachment" ], "summary": "Update an existing Work Order File Attachment 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 | WorkOrderFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | WorkOrderFileAttachment->FileName | string | |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | 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| fileName | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderFileAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order File Attachment 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": [ "Work Order File Attachment" ], "summary": "Delete an existing Work Order File Attachment 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 | WorkOrderFileAttachment->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": "DeleteWorkOrderFileAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order File Attachment 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/WM/WorkOrders/{id}/FileAttachments": { "get": { "tags": [ "Work Order File Attachment" ], "summary": "Get a collection of Work Order File Attachment resources for the Work Order.", "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 | WorkOrderFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderFileAttachment->Version | integer | int32 |\r\n| fileFullName | WorkOrderFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkOrderFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkOrderFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkOrderFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderFileAttachmentCollectionForWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "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 Work Order File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderFileAttachmentCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments": { "get": { "tags": [ "Work Order File Attachment" ], "summary": "Get a collection of Work Order File Attachment 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 | WorkOrderFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderFileAttachment->Version | integer | int32 |\r\n| workOrderId | WorkOrderFileAttachment->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderFileAttachment->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderFileAttachment->WorkOrder_Description | string | |\r\n| fileFullName | WorkOrderFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkOrderFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | WorkOrderFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkOrderFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkOrderFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderFileAttachmentCollection", "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 Work Order File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/Upload": { "post": { "tags": [ "Work Order File Attachment" ], "summary": "Upload and create a new Work Order File Attachment 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| workOrderId | WorkOrderFileAttachment->WorkOrder_Id | integer | int64 |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkOrderFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateWorkOrderFileAttachmentResourceActionRequest" } } ], "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" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/{id}/Upload": { "put": { "tags": [ "Work Order File Attachment" ], "summary": "Upload new content for an existing Work Order File Attachment 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 | WorkOrderFileAttachment->Version | integer | int32 |\r\n| bytes | WorkOrderFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderFileAttachmentContent", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Work Order File Attachment" ], "summary": "Get a collection of Work Order File Attachment 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| workOrderId | WorkOrderFileAttachment->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderFileAttachment->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderFileAttachment->WorkOrder_Description | string | |\r\n| createdByUserId | WorkOrderFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkOrderFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkOrderFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkOrderFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkOrderFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkOrderFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkOrderFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkOrderFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkOrderFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkOrderFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkOrderFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkOrderFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkOrderFileAttachment->FileFullName | string | |\r\n| fileName | WorkOrderFileAttachment->FileName | string | |\r\n| fileTypeId | WorkOrderFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkOrderFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| id | WorkOrderFileAttachment->Id | integer | int64 |\r\n| isActive | WorkOrderFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkOrderFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderFileAttachment", "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 Work Order File Attachment 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 Work Order File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Work Order File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Work Order File Attachment.", "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 | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetWorkOrderFileAttachmentContentHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/Upload/Batch": { "post": { "tags": [ "Work Order File Attachment" ], "summary": "Upload and create a new collection of Work Order File Attachment 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| workOrderId | WorkOrderFileAttachment->WorkOrder_Id | integer | int64 |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkOrderFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateWorkOrderFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/FileAttachments/Batch": { "patch": { "tags": [ "Work Order File Attachment" ], "summary": "Update a collection of existing Work Order File Attachment 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 | WorkOrderFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderFileAttachment->Version | integer | int32 |\r\n| isRestricted | WorkOrderFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderFileAttachment->FileCategory_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| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderFileAttachment", "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/BatchUpdateWorkOrderFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order File Attachment 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": [ "Work Order File Attachment" ], "summary": "Delete a collection of existing Work Order File Attachment 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 | WorkOrderFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderFileAttachment->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": "BatchDeleteWorkOrderFileAttachment", "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/BatchDeleteWorkOrderFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order File Attachment 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/WM/WorkOrderImportances/{id}": { "get": { "tags": [ "Work Order Importance" ], "summary": "Get a Work Order Importance 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 | WorkOrderImportance->Code | string | |\r\n| createdByUserId | WorkOrderImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderImportance->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderImportance->CreatedOn | string | date-time |\r\n| isActive | WorkOrderImportance->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderImportance->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderImportance->PermissionTree_Description | string | |\r\n| version | WorkOrderImportance->Version | integer | int32 |\r\n| id | WorkOrderImportance->Id | integer | int64 |\r\n| description | WorkOrderImportance->Description | string | |\r\n| notes | WorkOrderImportance->Notes | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n", "operationId": "GetWorkOrderImportance", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Importance Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Importance", "schema": { "$ref": "#/definitions/GetWorkOrderImportanceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Importance" ], "summary": "Update an existing Work Order Importance 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 | WorkOrderImportance->Version | integer | int32 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderImportance->Notes | string | |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateWorkOrderImportance", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Importance 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": [ "Work Order Importance" ], "summary": "Delete an existing Work Order Importance 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 | WorkOrderImportance->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": "DeleteWorkOrderImportance", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Importance Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Importance 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/WM/WorkOrderImportances": { "get": { "tags": [ "Work Order Importance" ], "summary": "Get a collection of Work Order Importance 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 | WorkOrderImportance->Version | integer | int32 |\r\n| id | WorkOrderImportance->Id | integer | int64 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n", "operationId": "GetWorkOrderImportanceCollection", "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 Work Order Importance collection", "schema": { "$ref": "#/definitions/GetWorkOrderImportanceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Importance" ], "summary": "Create a new Work Order Importance 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 | WorkOrderImportance->PermissionTree_Id | integer | int64 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n| notes | WorkOrderImportance->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| weight | Required | True | |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateWorkOrderImportance", "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/CreateWorkOrderImportanceResourceActionRequest" } }, { "$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/WM/WorkOrderImportances/Lookups/LookupWorkOrderImportanceChangePermissionTree": { "get": { "tags": [ "Work Order Importance" ], "summary": "Lookup the permission set for changing the Work Order Importance.", "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": "LookupWorkOrderImportanceChangePermissionTree", "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/WorkOrderImportanceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderImportances/Lookups/LookupWorkOrderImportanceInsertPermissionTree": { "get": { "tags": [ "Work Order Importance" ], "summary": "Lookup the permission set for creating the Work Order Importance.", "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": "LookupWorkOrderImportanceInsertPermissionTree", "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/WorkOrderImportanceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderImportances/Batch/{ids}": { "get": { "tags": [ "Work Order Importance" ], "summary": "Get a collection of Work Order Importance 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 | WorkOrderImportance->Code | string | |\r\n| createdByUserId | WorkOrderImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderImportance->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderImportance->CreatedOn | string | date-time |\r\n| isActive | WorkOrderImportance->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderImportance->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderImportance->PermissionTree_Description | string | |\r\n| version | WorkOrderImportance->Version | integer | int32 |\r\n| id | WorkOrderImportance->Id | integer | int64 |\r\n| description | WorkOrderImportance->Description | string | |\r\n| notes | WorkOrderImportance->Notes | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderImportance", "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 Work Order Importance 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 Work Order Importance collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderImportanceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderImportances/Batch": { "post": { "tags": [ "Work Order Importance" ], "summary": "Create a new collection of Work Order Importance 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 | WorkOrderImportance->PermissionTree_Id | integer | int64 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n| notes | WorkOrderImportance->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| weight | Required | True | |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateWorkOrderImportance", "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/BatchCreateWorkOrderImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Importance 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": [ "Work Order Importance" ], "summary": "Update a collection of existing Work Order Importance 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 | WorkOrderImportance->Id | integer | int64 |\r\n| version | WorkOrderImportance->Version | integer | int32 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n| sequenceNumber | WorkOrderImportance->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderImportance->Notes | string | |\r\n| weight | WorkOrderImportance->Weight | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateWorkOrderImportance", "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/BatchUpdateWorkOrderImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Importance 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": [ "Work Order Importance" ], "summary": "Delete a collection of existing Work Order Importance 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 | WorkOrderImportance->Id | integer | int64 |\r\n| version | WorkOrderImportance->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": "BatchDeleteWorkOrderImportance", "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/BatchDeleteWorkOrderImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Importance 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/WM/WorkOrderImportances/{id}/Active": { "patch": { "tags": [ "Work Order Importance" ], "summary": "Change the IsActive status for an existing Work Order Importance 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 | WorkOrderImportance->Version | integer | int32 |\r\n| isActive | WorkOrderImportance->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": "ChangeWorkOrderImportanceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderImportanceIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderImportances/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Importance" ], "summary": "Change the PermissionTree for an existing Work Order Importance 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 | WorkOrderImportance->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderImportance->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": "ChangeWorkOrderImportancePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderImportancePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderImportances/Batch/Active": { "patch": { "tags": [ "Work Order Importance" ], "summary": "Change the IsActive status for a collection of existing Work Order Importance 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 | WorkOrderImportance->Id | integer | int64 |\r\n| version | WorkOrderImportance->Version | integer | int32 |\r\n| isActive | WorkOrderImportance->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": "BatchChangeWorkOrderImportanceIsActive", "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/BatchChangeWorkOrderImportanceIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderImportances/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Importance" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Importance 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 | WorkOrderImportance->Id | integer | int64 |\r\n| version | WorkOrderImportance->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderImportance->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": "BatchChangeWorkOrderImportancePermissionTree", "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/BatchChangeWorkOrderImportancePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderImportances/MatchBatch": { "patch": { "tags": [ "Work Order Importance" ], "summary": "Update a collection of existing Work Order Importance 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 | WorkOrderImportance->Id | integer | int64 |\r\n| version | WorkOrderImportance->Version | integer | int32 |\r\n| description | WorkOrderImportance->Description | string | |\r\n| notes | WorkOrderImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "MatchUpdateWorkOrderImportance", "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/MatchUpdateWorkOrderImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Importance 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/WM/WorkOrders/Meters/{id}": { "get": { "tags": [ "Work Order Meter" ], "summary": "Get a Work Order 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| createdByUserId | WorkOrderMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderMeter->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderMeter->CreatedOn | string | date-time |\r\n| id | WorkOrderMeter->Id | integer | int64 |\r\n| version | WorkOrderMeter->Version | integer | int32 |\r\n| meterId | WorkOrderMeter->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderMeter->Meter_Code | string | |\r\n| meterLastReading | WorkOrderMeter->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | WorkOrderMeter->Meter_AverageDailyRate | number | decimal |\r\n| meterCumulativeReading | WorkOrderMeter->Meter_CumulativeReading | number | decimal |\r\n| meterLastReadOn | WorkOrderMeter->Meter_LastReadOn | string | date-time |\r\n| meterNotes | WorkOrderMeter->Meter_Notes | string | |\r\n| meterDescription | WorkOrderMeter->Meter_Description | string | |\r\n| meterReadingId | WorkOrderMeter->MeterReading_Id | integer | int64 |\r\n| readingOn | WorkOrderMeter->ReadingOn | string | date-time |\r\n| readingValue | WorkOrderMeter->ReadingValue | number | decimal |\r\n| scheduledDate | WorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | WorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n| scheduledWorkOrderTaskId | WorkOrderMeter->ScheduledWorkOrderTask_Id | integer | int64 |\r\n| scheduledWorkOrderTaskAssetTreePathId | WorkOrderMeter->ScheduledWorkOrderTask_AssetTreePathId | integer | int64 |\r\n| scheduledWorkOrderTaskAssetTreePathItems | WorkOrderMeter->ScheduledWorkOrderTask_AssetTreePathItems | array | array |\r\n| scheduledWorkOrderTaskCompleted | WorkOrderMeter->ScheduledWorkOrderTask_Completed | boolean | |\r\n| scheduledWorkOrderTaskComponentTreePathId | WorkOrderMeter->ScheduledWorkOrderTask_ComponentTreePathId | integer | int64 |\r\n| scheduledWorkOrderTaskComponentTreePathItems | WorkOrderMeter->ScheduledWorkOrderTask_ComponentTreePathItems | array | array |\r\n| scheduledWorkOrderTaskTaskCode | WorkOrderMeter->ScheduledWorkOrderTask_TaskCode | string | |\r\n| scheduledWorkOrderTaskTaskDescription | WorkOrderMeter->ScheduledWorkOrderTask_TaskDescription | string | |\r\n| scheduledWorkOrderTaskTaskType | WorkOrderMeter->ScheduledWorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderId | WorkOrderMeter->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMeter->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMeter->WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderMeter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Meter", "schema": { "$ref": "#/definitions/GetWorkOrderMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Meter" ], "summary": "Update an existing Work Order 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 | WorkOrderMeter->Version | integer | int32 |\r\n| readingValue | WorkOrderMeter->ReadingValue | number | decimal |\r\n| readingOn | WorkOrderMeter->ReadingOn | string | date-time |\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": "UpdateWorkOrderMeter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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" } } } }, "/Modules/WM/WorkOrders/{workOrderId}/Meters": { "get": { "tags": [ "Work Order Meter" ], "summary": "Get a collection of Work Order Meter resources for the Work Order.", "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 | WorkOrderMeter->Id | integer | int64 |\r\n| version | WorkOrderMeter->Version | integer | int32 |\r\n| meterId | WorkOrderMeter->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderMeter->Meter_Code | string | |\r\n| meterDescription | WorkOrderMeter->Meter_Description | string | |\r\n| meterLastReading | WorkOrderMeter->Meter_LastReading | number | decimal |\r\n| meterLastReadOn | WorkOrderMeter->Meter_LastReadOn | string | date-time |\r\n| scheduledDate | WorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | WorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n| readingValue | WorkOrderMeter->ReadingValue | number | decimal |\r\n| readingOn | WorkOrderMeter->ReadingOn | string | date-time |\r\n", "operationId": "GetMeterCollectionForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Meter collection", "schema": { "$ref": "#/definitions/GetWorkOrderMeterCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Meters": { "get": { "tags": [ "Work Order Meter" ], "summary": "Get a collection of Work Order 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| id | WorkOrderMeter->Id | integer | int64 |\r\n| version | WorkOrderMeter->Version | integer | int32 |\r\n| workOrderCode | WorkOrderMeter->WorkOrder_Code | string | |\r\n| meterCode | WorkOrderMeter->Meter_Code | string | |\r\n| meterNotes | WorkOrderMeter->Meter_Notes | string | |\r\n| meterLastReading | WorkOrderMeter->Meter_LastReading | number | decimal |\r\n| meterLastReadOn | WorkOrderMeter->Meter_LastReadOn | string | date-time |\r\n| meterAverageDailyRate | WorkOrderMeter->Meter_AverageDailyRate | number | decimal |\r\n| meterDescription | WorkOrderMeter->Meter_Description | string | |\r\n| scheduledDate | WorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | WorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n| readingValue | WorkOrderMeter->ReadingValue | number | decimal |\r\n| readingOn | WorkOrderMeter->ReadingOn | string | date-time |\r\n", "operationId": "GetWorkOrderMeterCollection", "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 Work Order Meter collection", "schema": { "$ref": "#/definitions/GetWorkOrderMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Meters/Batch/{ids}": { "get": { "tags": [ "Work Order Meter" ], "summary": "Get a collection of Work Order 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| createdByUserId | WorkOrderMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderMeter->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderMeter->CreatedOn | string | date-time |\r\n| id | WorkOrderMeter->Id | integer | int64 |\r\n| version | WorkOrderMeter->Version | integer | int32 |\r\n| meterId | WorkOrderMeter->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderMeter->Meter_Code | string | |\r\n| meterLastReading | WorkOrderMeter->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | WorkOrderMeter->Meter_AverageDailyRate | number | decimal |\r\n| meterCumulativeReading | WorkOrderMeter->Meter_CumulativeReading | number | decimal |\r\n| meterLastReadOn | WorkOrderMeter->Meter_LastReadOn | string | date-time |\r\n| meterNotes | WorkOrderMeter->Meter_Notes | string | |\r\n| meterDescription | WorkOrderMeter->Meter_Description | string | |\r\n| meterReadingId | WorkOrderMeter->MeterReading_Id | integer | int64 |\r\n| readingOn | WorkOrderMeter->ReadingOn | string | date-time |\r\n| readingValue | WorkOrderMeter->ReadingValue | number | decimal |\r\n| scheduledDate | WorkOrderMeter->ScheduledDate | string | date |\r\n| scheduledMeterReading | WorkOrderMeter->ScheduledMeterReading | number | decimal |\r\n| scheduledWorkOrderTaskId | WorkOrderMeter->ScheduledWorkOrderTask_Id | integer | int64 |\r\n| scheduledWorkOrderTaskAssetTreePathId | WorkOrderMeter->ScheduledWorkOrderTask_AssetTreePathId | integer | int64 |\r\n| scheduledWorkOrderTaskAssetTreePathItems | WorkOrderMeter->ScheduledWorkOrderTask_AssetTreePathItems | array | array |\r\n| scheduledWorkOrderTaskCompleted | WorkOrderMeter->ScheduledWorkOrderTask_Completed | boolean | |\r\n| scheduledWorkOrderTaskComponentTreePathId | WorkOrderMeter->ScheduledWorkOrderTask_ComponentTreePathId | integer | int64 |\r\n| scheduledWorkOrderTaskComponentTreePathItems | WorkOrderMeter->ScheduledWorkOrderTask_ComponentTreePathItems | array | array |\r\n| scheduledWorkOrderTaskTaskCode | WorkOrderMeter->ScheduledWorkOrderTask_TaskCode | string | |\r\n| scheduledWorkOrderTaskTaskDescription | WorkOrderMeter->ScheduledWorkOrderTask_TaskDescription | string | |\r\n| scheduledWorkOrderTaskTaskType | WorkOrderMeter->ScheduledWorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderId | WorkOrderMeter->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMeter->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMeter->WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderMeter", "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 Work Order 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 Work Order Meter collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderMeterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Meters/Batch": { "patch": { "tags": [ "Work Order Meter" ], "summary": "Update a collection of existing Work Order 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 | WorkOrderMeter->Id | integer | int64 |\r\n| version | WorkOrderMeter->Version | integer | int32 |\r\n| readingValue | WorkOrderMeter->ReadingValue | number | decimal |\r\n| readingOn | WorkOrderMeter->ReadingOn | string | date-time |\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": "BatchUpdateWorkOrderMeter", "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/BatchUpdateWorkOrderMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order 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/WM/WorkOrders/Meters/ValidateMeterAdr": { "post": { "tags": [ "Work Order Meter" ], "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| workOrderId | ValidateWMMeterAdrEntity->WorkOrder_Id | integer | int64 |\r\n| meterId | ValidateWMMeterAdrEntity->Meter_Id | integer | int64 |\r\n| meterReadingId | ValidateWMMeterAdrEntity->MeterReading_Id | integer | int64 |\r\n| readingValue | ValidateWMMeterAdrEntity->ReadingValue | number | decimal |\r\n| readingOn | ValidateWMMeterAdrEntity->ReadingOn | string | date-time |\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| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "ValidateWorkOrderMeterAdr", "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/ValidateWorkOrderMeterAdrResourceActionRequest" } }, { "$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/WM/WorkOrders/MonitoringPoints/{id}": { "get": { "tags": [ "Work Order Monitoring Point" ], "summary": "Get a Work Order Monitoring Point resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | WorkOrderMonitoringPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderMonitoringPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderMonitoringPoint->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderMonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderMonitoringPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderMonitoringPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderMonitoringPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderMonitoringPoint->ModifiedOn | string | date-time |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderMonitoringPoint->PermissionTree_Description | string | |\r\n| id | WorkOrderMonitoringPoint->Id | integer | int64 |\r\n| lowerCriticalBound | WorkOrderMonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | WorkOrderMonitoringPoint->LowerWarningBound | number | decimal |\r\n| monitoringPointId | WorkOrderMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | WorkOrderMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | WorkOrderMonitoringPoint->MonitoringPoint_Description | string | |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| notes | WorkOrderMonitoringPoint->Notes | string | |\r\n| upperCriticalBound | WorkOrderMonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | WorkOrderMonitoringPoint->UpperWarningBound | number | decimal |\r\n| workOrderId | WorkOrderMonitoringPoint->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMonitoringPoint->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMonitoringPoint->WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderMonitoringPoint", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Monitoring Point Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Monitoring Point", "schema": { "$ref": "#/definitions/GetWorkOrderMonitoringPointResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Monitoring Point" ], "summary": "Update an existing Work Order Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| notes | WorkOrderMonitoringPoint->Notes | string | |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\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| monitoringPointReadingValue | Nullable | False | WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null |\r\n| monitoringPointReadingValue | Nullable | True | WorkOrderMonitoringPoint->MonitoringPointReadingDate eq null |\r\n\r\n", "operationId": "UpdateWorkOrderMonitoringPoint", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Monitoring Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderMonitoringPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Monitoring Point 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/WM/WorkOrders/MonitoringPoints": { "get": { "tags": [ "Work Order Monitoring Point" ], "summary": "Get a collection of Work Order Monitoring Point resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderMonitoringPoint->PermissionTree_Description | string | |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| monitoringPointId | WorkOrderMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | WorkOrderMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | WorkOrderMonitoringPoint->MonitoringPoint_Description | string | |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| workOrderId | WorkOrderMonitoringPoint->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMonitoringPoint->WorkOrder_Code | string | |\r\n| workOrderStatusDescription | WorkOrderMonitoringPoint->WorkOrder_Status_Description | string | |\r\n| upperCriticalBound | WorkOrderMonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | WorkOrderMonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerWarningBound | WorkOrderMonitoringPoint->LowerWarningBound | number | decimal |\r\n| lowerCriticalBound | WorkOrderMonitoringPoint->LowerCriticalBound | number | decimal |\r\n", "operationId": "GetWorkOrderMonitoringPointCollection", "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 Work Order Monitoring Point collection", "schema": { "$ref": "#/definitions/GetWorkOrderMonitoringPointCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Monitoring Point" ], "summary": "Create a new Work Order Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| workOrderId | WorkOrderMonitoringPoint->WorkOrder_Id | integer | int64 |\r\n| monitoringPointId | WorkOrderMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\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| workOrderId | System Generated | true | If no value specified |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| monitoringPointReadingValue | Nullable | False | WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null |\r\n| monitoringPointReadingValue | Nullable | True | WorkOrderMonitoringPoint->MonitoringPointReadingDate eq null |\r\n\r\n", "operationId": "CreateWorkOrderMonitoringPoint", "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/CreateWorkOrderMonitoringPointResourceActionRequest" } }, { "$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/WM/WorkOrders/{workOrderId}/MonitoringPoints": { "get": { "tags": [ "Work Order Monitoring Point" ], "summary": "Get a collection of Work Order Monitoring Point resources for the Work Order", "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 | WorkOrderMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderMonitoringPoint->PermissionTree_Description | string | |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| monitoringPointCode | WorkOrderMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| upperCriticalBound | WorkOrderMonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | WorkOrderMonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerWarningBound | WorkOrderMonitoringPoint->LowerWarningBound | number | decimal |\r\n| lowerCriticalBound | WorkOrderMonitoringPoint->LowerCriticalBound | number | decimal |\r\n", "operationId": "GetWorkOrderMonitoringPointForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Monitoring Point collection", "schema": { "$ref": "#/definitions/GetWorkOrderMonitoringPointForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/MonitoringPoints/Lookups/LookupWorkOrderMonitoringPointChangePermissionTree": { "get": { "tags": [ "Work Order Monitoring Point" ], "summary": "Lookup the permission set for changing the Work Order Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupWorkOrderMonitoringPointChangePermissionTree", "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/WorkOrderMonitoringPointChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/MonitoringPoints/Lookups/LookupWorkOrderMonitoringPointInsertPermissionTree": { "get": { "tags": [ "Work Order Monitoring Point" ], "summary": "Lookup the permission set for creating the Work Order Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupWorkOrderMonitoringPointInsertPermissionTree", "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/WorkOrderMonitoringPointInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/MonitoringPoints/Batch/{ids}": { "get": { "tags": [ "Work Order Monitoring Point" ], "summary": "Get a collection of Work Order Monitoring Point resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | WorkOrderMonitoringPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderMonitoringPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderMonitoringPoint->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderMonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderMonitoringPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderMonitoringPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderMonitoringPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderMonitoringPoint->ModifiedOn | string | date-time |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderMonitoringPoint->PermissionTree_Description | string | |\r\n| id | WorkOrderMonitoringPoint->Id | integer | int64 |\r\n| lowerCriticalBound | WorkOrderMonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | WorkOrderMonitoringPoint->LowerWarningBound | number | decimal |\r\n| monitoringPointId | WorkOrderMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | WorkOrderMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | WorkOrderMonitoringPoint->MonitoringPoint_Description | string | |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| notes | WorkOrderMonitoringPoint->Notes | string | |\r\n| upperCriticalBound | WorkOrderMonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | WorkOrderMonitoringPoint->UpperWarningBound | number | decimal |\r\n| workOrderId | WorkOrderMonitoringPoint->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMonitoringPoint->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMonitoringPoint->WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderMonitoringPoint", "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 Work Order Monitoring Point 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 Work Order Monitoring Point collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderMonitoringPointResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/MonitoringPoints/Batch": { "post": { "tags": [ "Work Order Monitoring Point" ], "summary": "Create a new collection of Work Order Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| workOrderId | WorkOrderMonitoringPoint->WorkOrder_Id | integer | int64 |\r\n| monitoringPointId | WorkOrderMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\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| workOrderId | System Generated | true | If no value specified |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| monitoringPointReadingValue | Nullable | False | WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null |\r\n| monitoringPointReadingValue | Nullable | True | WorkOrderMonitoringPoint->MonitoringPointReadingDate eq null |\r\n\r\n", "operationId": "BatchCreateWorkOrderMonitoringPoint", "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/BatchCreateWorkOrderMonitoringPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Monitoring Point 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": [ "Work Order Monitoring Point" ], "summary": "Update a collection of existing Work Order Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| notes | WorkOrderMonitoringPoint->Notes | string | |\r\n| monitoringPointReadingValue | WorkOrderMonitoringPoint->MonitoringPointReadingValue | number | decimal |\r\n| monitoringPointReadingDate | WorkOrderMonitoringPoint->MonitoringPointReadingDate | string | date-time |\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| monitoringPointReadingValue | Nullable | False | WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null |\r\n| monitoringPointReadingValue | Nullable | True | WorkOrderMonitoringPoint->MonitoringPointReadingDate eq null |\r\n\r\n", "operationId": "BatchUpdateWorkOrderMonitoringPoint", "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/BatchUpdateWorkOrderMonitoringPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Monitoring Point 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/WM/WorkOrders/MonitoringPoints/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Monitoring Point" ], "summary": "Change the PermissionTree for an existing Work Order Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->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": "ChangeWorkOrderMonitoringPointPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Monitoring Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/MonitoringPoints/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Monitoring Point" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderMonitoringPoint->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": "BatchChangeWorkOrderMonitoringPointPermissionTree", "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/BatchChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Movements/{id}": { "get": { "tags": [ "Work Order Movement" ], "summary": "Get a Work Order Movement 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 | WorkOrderMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderMovement->Id | integer | int64 |\r\n| version | WorkOrderMovement->Version | integer | int32 |\r\n| action | WorkOrderMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| workOrderId | WorkOrderMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMovement->WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderMovement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Movement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Movement", "schema": { "$ref": "#/definitions/GetWorkOrderMovementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Movements": { "get": { "tags": [ "Work Order Movement" ], "summary": "Get a collection of Work Order Movement 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 | WorkOrderMovement->Id | integer | int64 |\r\n| version | WorkOrderMovement->Version | integer | int32 |\r\n| workOrderCode | WorkOrderMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMovement->WorkOrder_Description | string | |\r\n| action | WorkOrderMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| createdOn | WorkOrderMovement->CreatedOn | string | date-time |\r\n| createdByUserFullName | WorkOrderMovement->CreatedByUser_FullName | string | |\r\n", "operationId": "GetWorkOrderMovementCollection", "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 Work Order Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Movements/Batch/{ids}": { "get": { "tags": [ "Work Order Movement" ], "summary": "Get a collection of Work Order Movement 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 | WorkOrderMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderMovement->Id | integer | int64 |\r\n| version | WorkOrderMovement->Version | integer | int32 |\r\n| action | WorkOrderMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| workOrderId | WorkOrderMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderMovement->WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderMovement", "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 Work Order Movement 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 Work Order Movement collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderMovementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/{id}": { "get": { "tags": [ "Work Order Progress Event" ], "summary": "Get a Work Order Progress Event 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 | WorkOrderProgressEvent->Code | string | |\r\n| isActive | WorkOrderProgressEvent->IsActive | boolean | |\r\n| createdByUserId | WorkOrderProgressEvent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderProgressEvent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderProgressEvent->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderProgressEvent->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderProgressEvent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderProgressEvent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderProgressEvent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderProgressEvent->ModifiedOn | string | date-time |\r\n| version | WorkOrderProgressEvent->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEvent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderProgressEvent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderProgressEvent->PermissionTree_Description | string | |\r\n| id | WorkOrderProgressEvent->Id | integer | int64 |\r\n| allowAsFirstEvent | WorkOrderProgressEvent->AllowAsFirstEvent | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| notes | WorkOrderProgressEvent->Notes | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| workOrderStatusId | WorkOrderProgressEvent->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderProgressEvent->WorkOrderStatus_Code | string | |\r\n| workOrderStatusBaseStatus | WorkOrderProgressEvent->WorkOrderStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStatusDescription | WorkOrderProgressEvent->WorkOrderStatus_Description | string | |\r\n| workOrderStatusSequenceNumber | WorkOrderProgressEvent->WorkOrderStatus_SequenceNumber | integer | int32 |\r\n", "operationId": "GetWorkOrderProgressEvent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Progress Event", "schema": { "$ref": "#/definitions/GetWorkOrderProgressEventResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Progress Event" ], "summary": "Update an existing Work Order Progress Event 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 | WorkOrderProgressEvent->Version | integer | int32 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| allowAsFirstEvent | WorkOrderProgressEvent->AllowAsFirstEvent | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| workOrderStatusId | WorkOrderProgressEvent->WorkOrderStatus_Id | integer | int64 |\r\n| notes | WorkOrderProgressEvent->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 | Nullable | False | |\r\n| code | Pattern | ^[a-zA-Z]*$ | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 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| reasonRequired | Nullable | False | |\r\n| allowAsFirstEvent | Nullable | False | |\r\n| applyEventRestrictions | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderProgressEvent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderProgressEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event 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": [ "Work Order Progress Event" ], "summary": "Delete an existing Work Order Progress Event 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 | WorkOrderProgressEvent->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": "DeleteWorkOrderProgressEvent", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderProgressEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event 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/WM/WorkOrderProgressEvents": { "get": { "tags": [ "Work Order Progress Event" ], "summary": "Get a collection of Work Order Progress Event 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 | WorkOrderProgressEvent->Version | integer | int32 |\r\n| id | WorkOrderProgressEvent->Id | integer | int64 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| workOrderStatusCode | WorkOrderProgressEvent->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderProgressEvent->WorkOrderStatus_Description | string | |\r\n| workOrderStatusBaseStatus | WorkOrderProgressEvent->WorkOrderStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| notes | WorkOrderProgressEvent->Notes | string | |\r\n| createdOn | WorkOrderProgressEvent->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderProgressEvent->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderProgressEventCollection", "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 Work Order Progress Event collection", "schema": { "$ref": "#/definitions/GetWorkOrderProgressEventCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Progress Event" ], "summary": "Create a new Work Order Progress Event 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 | WorkOrderProgressEvent->PermissionTree_Id | integer | int64 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| allowAsFirstEvent | WorkOrderProgressEvent->AllowAsFirstEvent | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| workOrderStatusId | WorkOrderProgressEvent->WorkOrderStatus_Id | integer | int64 |\r\n| notes | WorkOrderProgressEvent->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 | Pattern | ^[a-zA-Z]*$ | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 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| reasonRequired | Nullable | False | |\r\n| allowAsFirstEvent | Nullable | False | |\r\n| applyEventRestrictions | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderProgressEvent", "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/CreateWorkOrderProgressEventResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/Lookups/LookupWorkOrderProgressEventChangePermissionTree": { "get": { "tags": [ "Work Order Progress Event" ], "summary": "Lookup the permission set for changing the Work Order Progress Event.", "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": "LookupWorkOrderProgressEventChangePermissionTree", "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/WorkOrderProgressEventChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/Lookups/LookupWorkOrderProgressEventInsertPermissionTree": { "get": { "tags": [ "Work Order Progress Event" ], "summary": "Work Order Progress Event", "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": "LookupWorkOrderProgressEventInsertPermissionTree", "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/WorkOrderProgressEventInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/Lookups/LookupWorkOrderProgressEventWorkOrderStatus": { "get": { "tags": [ "Work Order Progress Event" ], "summary": "Lookup the Work Order Status for the Work Order Progress Event.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "LookupWorkOrderProgressEventWorkOrderStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/WorkOrderProgressEventWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/Batch/{ids}": { "get": { "tags": [ "Work Order Progress Event" ], "summary": "Get a collection of Work Order Progress Event 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 | WorkOrderProgressEvent->Code | string | |\r\n| isActive | WorkOrderProgressEvent->IsActive | boolean | |\r\n| createdByUserId | WorkOrderProgressEvent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderProgressEvent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderProgressEvent->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderProgressEvent->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderProgressEvent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderProgressEvent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderProgressEvent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderProgressEvent->ModifiedOn | string | date-time |\r\n| version | WorkOrderProgressEvent->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEvent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderProgressEvent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderProgressEvent->PermissionTree_Description | string | |\r\n| id | WorkOrderProgressEvent->Id | integer | int64 |\r\n| allowAsFirstEvent | WorkOrderProgressEvent->AllowAsFirstEvent | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| notes | WorkOrderProgressEvent->Notes | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| workOrderStatusId | WorkOrderProgressEvent->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderProgressEvent->WorkOrderStatus_Code | string | |\r\n| workOrderStatusBaseStatus | WorkOrderProgressEvent->WorkOrderStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStatusDescription | WorkOrderProgressEvent->WorkOrderStatus_Description | string | |\r\n| workOrderStatusSequenceNumber | WorkOrderProgressEvent->WorkOrderStatus_SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderProgressEvent", "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 Work Order Progress Event 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 Work Order Progress Event collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderProgressEventResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/Batch": { "post": { "tags": [ "Work Order Progress Event" ], "summary": "Create a new collection of Work Order Progress Event 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 | WorkOrderProgressEvent->PermissionTree_Id | integer | int64 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| allowAsFirstEvent | WorkOrderProgressEvent->AllowAsFirstEvent | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| workOrderStatusId | WorkOrderProgressEvent->WorkOrderStatus_Id | integer | int64 |\r\n| notes | WorkOrderProgressEvent->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 | Pattern | ^[a-zA-Z]*$ | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 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| reasonRequired | Nullable | False | |\r\n| allowAsFirstEvent | Nullable | False | |\r\n| applyEventRestrictions | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderProgressEvent", "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/BatchCreateWorkOrderProgressEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Progress Event 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": [ "Work Order Progress Event" ], "summary": "Update a collection of existing Work Order Progress Event 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 | WorkOrderProgressEvent->Id | integer | int64 |\r\n| version | WorkOrderProgressEvent->Version | integer | int32 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n| sequenceNumber | WorkOrderProgressEvent->SequenceNumber | integer | int32 |\r\n| reasonRequired | WorkOrderProgressEvent->ReasonRequired | boolean | |\r\n| allowAsFirstEvent | WorkOrderProgressEvent->AllowAsFirstEvent | boolean | |\r\n| applyEventRestrictions | WorkOrderProgressEvent->ApplyEventRestrictions | boolean | |\r\n| workOrderStatusId | WorkOrderProgressEvent->WorkOrderStatus_Id | integer | int64 |\r\n| notes | WorkOrderProgressEvent->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 | Nullable | False | |\r\n| code | Pattern | ^[a-zA-Z]*$ | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 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| reasonRequired | Nullable | False | |\r\n| allowAsFirstEvent | Nullable | False | |\r\n| applyEventRestrictions | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderProgressEvent", "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/BatchUpdateWorkOrderProgressEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event 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": [ "Work Order Progress Event" ], "summary": "Delete a collection of existing Work Order Progress Event 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 | WorkOrderProgressEvent->Id | integer | int64 |\r\n| version | WorkOrderProgressEvent->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": "BatchDeleteWorkOrderProgressEvent", "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/BatchDeleteWorkOrderProgressEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event 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/WM/WorkOrderProgressEvents/{id}/Active": { "patch": { "tags": [ "Work Order Progress Event" ], "summary": "Change the IsActive status for an existing Work Order Progress Event 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 | WorkOrderProgressEvent->Version | integer | int32 |\r\n| isActive | WorkOrderProgressEvent->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": "ChangeWorkOrderProgressEventIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderProgressEventIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Progress Event" ], "summary": "Change the PermissionTree for an existing Work Order Progress Event 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 | WorkOrderProgressEvent->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEvent->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": "ChangeWorkOrderProgressEventPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderProgressEventPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/Batch/Active": { "patch": { "tags": [ "Work Order Progress Event" ], "summary": "Change the IsActive status for a collection of existing Work Order Progress Event 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 | WorkOrderProgressEvent->Id | integer | int64 |\r\n| version | WorkOrderProgressEvent->Version | integer | int32 |\r\n| isActive | WorkOrderProgressEvent->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": "BatchChangeWorkOrderProgressEventIsActive", "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/BatchChangeWorkOrderProgressEventIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Progress Event" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Progress Event 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 | WorkOrderProgressEvent->Id | integer | int64 |\r\n| version | WorkOrderProgressEvent->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEvent->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": "BatchChangeWorkOrderProgressEventPermissionTree", "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/BatchChangeWorkOrderProgressEventPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/AllowedChanges/{id}": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Get a Work Order Progress Event Allowed Change resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | WorkOrderProgressEventAllowedChange->IsActive | boolean | |\r\n| createdByUserId | WorkOrderProgressEventAllowedChange->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderProgressEventAllowedChange->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderProgressEventAllowedChange->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderProgressEventAllowedChange->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderProgressEventAllowedChange->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderProgressEventAllowedChange->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderProgressEventAllowedChange->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderProgressEventAllowedChange->ModifiedOn | string | date-time |\r\n| version | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEventAllowedChange->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderProgressEventAllowedChange->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderProgressEventAllowedChange->PermissionTree_Description | string | |\r\n| id | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| notes | WorkOrderProgressEventAllowedChange->Notes | string | |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| eventId | WorkOrderProgressEventAllowedChange->Event_Id | integer | int64 |\r\n| eventCode | WorkOrderProgressEventAllowedChange->Event_Code | string | |\r\n| eventDescription | WorkOrderProgressEventAllowedChange->Event_Description | string | |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| allowedEventCode | WorkOrderProgressEventAllowedChange->AllowedEvent_Code | string | |\r\n| allowedEventDescription | WorkOrderProgressEventAllowedChange->AllowedEvent_Description | string | |\r\n", "operationId": "GetWorkOrderProgressEventAllowedChange", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Allowed Change Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Progress Event Allowed Change", "schema": { "$ref": "#/definitions/GetWorkOrderProgressEventAllowedChangeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Update an existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| notes | WorkOrderProgressEventAllowedChange->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| allowedEventId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderProgressEventAllowedChange", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event Allowed Change 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": [ "Work Order Progress Event Allowed Change" ], "summary": "Delete an existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->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": "DeleteWorkOrderProgressEventAllowedChange", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event Allowed Change 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/WM/WorkOrderProgressEvents/AllowedChanges": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Get a collection of Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| id | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| eventId | WorkOrderProgressEventAllowedChange->Event_Id | integer | int64 |\r\n| eventCode | WorkOrderProgressEventAllowedChange->Event_Code | string | |\r\n| eventDescription | WorkOrderProgressEventAllowedChange->Event_Description | string | |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| allowedEventCode | WorkOrderProgressEventAllowedChange->AllowedEvent_Code | string | |\r\n| allowedEventDescription | WorkOrderProgressEventAllowedChange->AllowedEvent_Description | string | |\r\n| notes | WorkOrderProgressEventAllowedChange->Notes | string | |\r\n| createdOn | WorkOrderProgressEventAllowedChange->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderProgressEventAllowedChange->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderProgressEventAllowedChangeCollection", "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 Work Order Progress Event Allowed Change collection", "schema": { "$ref": "#/definitions/GetWorkOrderProgressEventAllowedChangeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Create a new Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| eventId | WorkOrderProgressEventAllowedChange->Event_Id | integer | int64 |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| notes | WorkOrderProgressEventAllowedChange->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| eventId | Required | True | |\r\n| eventId | Nullable | False | |\r\n| allowedEventId | Required | True | |\r\n| allowedEventId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderProgressEventAllowedChange", "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/CreateWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/{eventId}/AllowedEvents": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Get a collection of Work Order Progress Event Allowed Change resources for the Work Order Progress Event.", "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 | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| allowedEventCode | WorkOrderProgressEventAllowedChange->AllowedEvent_Code | string | |\r\n| allowedEventDescription | WorkOrderProgressEventAllowedChange->AllowedEvent_Description | string | |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderProgressEventAllowedChange->Notes | string | |\r\n", "operationId": "GetWorkOrderProgressEventAllowedChangeForWorkOrderProgressEventCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "eventId", "in": "path", "required": true, "description": "Work Order Progress Event 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 Work Order Progress Event Allowed Change collection", "schema": { "$ref": "#/definitions/GetWorkOrderProgressEventAllowedChangeForWorkOrderProgressEventCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/AllowedChanges/Lookups/LookupWorkOrderProgressEventAllowedChangeChangePermissionTree": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Lookup the permission set for changing the Work Order Progress Event Allowed Change.", "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": "LookupWorkOrderProgressEventAllowedChangeChangePermissionTree", "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/WorkOrderProgressEventAllowedChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/AllowedChanges/Lookups/LookupWorkOrderProgressEventAllowedChangeInsertPermissionTree": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Lookup the permission set for creating the Work Order Progress Event Allowed Change.", "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": "LookupWorkOrderProgressEventAllowedChangeInsertPermissionTree", "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/WorkOrderProgressEventAllowedChangeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/AllowedChanges/Lookups/LookupWorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEvent": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Lookup the Work Order Progress Event for the Work Order Progress Event Allowed Change.", "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 | WorkOrderProgressEvent->Id | integer | int64 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n", "operationId": "LookupWorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEvent", "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 Work Order Progress Event collection", "schema": { "$ref": "#/definitions/WorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/AllowedChanges/Lookups/LookupWorkOrderProgressEventAllowedChangeWorkOrderProgressEvent": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Lookup the Work Order Progress Event for the Work Order Progress Event Allowed Change.", "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 | WorkOrderProgressEvent->Id | integer | int64 |\r\n| code | WorkOrderProgressEvent->Code | string | |\r\n| description | WorkOrderProgressEvent->Description | string | |\r\n", "operationId": "LookupWorkOrderProgressEventAllowedChangeWorkOrderProgressEvent", "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 Work Order Progress Event collection", "schema": { "$ref": "#/definitions/WorkOrderProgressEventAllowedChangeWorkOrderProgressEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/AllowedChanges/Batch/{ids}": { "get": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Get a collection of Work Order Progress Event Allowed Change resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | WorkOrderProgressEventAllowedChange->IsActive | boolean | |\r\n| createdByUserId | WorkOrderProgressEventAllowedChange->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderProgressEventAllowedChange->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderProgressEventAllowedChange->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderProgressEventAllowedChange->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderProgressEventAllowedChange->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderProgressEventAllowedChange->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderProgressEventAllowedChange->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderProgressEventAllowedChange->ModifiedOn | string | date-time |\r\n| version | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEventAllowedChange->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderProgressEventAllowedChange->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderProgressEventAllowedChange->PermissionTree_Description | string | |\r\n| id | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| notes | WorkOrderProgressEventAllowedChange->Notes | string | |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| eventId | WorkOrderProgressEventAllowedChange->Event_Id | integer | int64 |\r\n| eventCode | WorkOrderProgressEventAllowedChange->Event_Code | string | |\r\n| eventDescription | WorkOrderProgressEventAllowedChange->Event_Description | string | |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| allowedEventCode | WorkOrderProgressEventAllowedChange->AllowedEvent_Code | string | |\r\n| allowedEventDescription | WorkOrderProgressEventAllowedChange->AllowedEvent_Description | string | |\r\n", "operationId": "BatchGetWorkOrderProgressEventAllowedChange", "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 Work Order Progress Event Allowed Change 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 Work Order Progress Event Allowed Change collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderProgressEventAllowedChangeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderProgressEvents/AllowedChanges/Batch": { "post": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Create a new collection of Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| eventId | WorkOrderProgressEventAllowedChange->Event_Id | integer | int64 |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| notes | WorkOrderProgressEventAllowedChange->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| eventId | Required | True | |\r\n| eventId | Nullable | False | |\r\n| allowedEventId | Required | True | |\r\n| allowedEventId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderProgressEventAllowedChange", "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/BatchCreateWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Progress Event Allowed Change 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": [ "Work Order Progress Event Allowed Change" ], "summary": "Update a collection of existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderProgressEventAllowedChange->SequenceNumber | integer | int32 |\r\n| allowedEventId | WorkOrderProgressEventAllowedChange->AllowedEvent_Id | integer | int64 |\r\n| notes | WorkOrderProgressEventAllowedChange->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| allowedEventId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderProgressEventAllowedChange", "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/BatchUpdateWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event Allowed Change 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": [ "Work Order Progress Event Allowed Change" ], "summary": "Delete a collection of existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderProgressEventAllowedChange->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": "BatchDeleteWorkOrderProgressEventAllowedChange", "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/BatchDeleteWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Progress Event Allowed Change 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/WM/WorkOrderProgressEvents/AllowedChanges/{id}/Active": { "patch": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Change the IsActive status for an existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| isActive | WorkOrderProgressEventAllowedChange->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": "ChangeWorkOrderProgressEventAllowedChangeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderProgressEventAllowedChangeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/AllowedChanges/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Change the PermissionTree for an existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEventAllowedChange->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": "ChangeWorkOrderProgressEventAllowedChangePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Event Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/AllowedChanges/Batch/Active": { "patch": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Change the IsActive status for a collection of existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| isActive | WorkOrderProgressEventAllowedChange->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": "BatchChangeWorkOrderProgressEventAllowedChangeIsActive", "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/BatchChangeWorkOrderProgressEventAllowedEventIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderProgressEvents/AllowedChanges/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Progress Event Allowed Change" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Progress Event Allowed Change 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 | WorkOrderProgressEventAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderProgressEventAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderProgressEventAllowedChange->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": "BatchChangeWorkOrderProgressEventAllowedChangePermissionTree", "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/BatchChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/ProgressLog/{id}": { "get": { "tags": [ "Work Order Progress Log" ], "summary": "Get a Work Order Progress Log 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 | WorkOrderProgressLog->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderProgressLog->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderProgressLog->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderProgressLog->CreatedOn | string | date-time |\r\n| geographicId | WorkOrderProgressLog->GeographicId | integer | int64 |\r\n| geographicEndPosition | WorkOrderProgressLog->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | WorkOrderProgressLog->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | WorkOrderProgressLog->GeographicLength | number | decimal |\r\n| geographicLocation | WorkOrderProgressLog->GeographicLocation | object | |\r\n| geographicNotes | WorkOrderProgressLog->GeographicNotes | string | |\r\n| geographicReferenceEntityId | WorkOrderProgressLog->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | WorkOrderProgressLog->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | WorkOrderProgressLog->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrderProgressLog->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | WorkOrderProgressLog->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | WorkOrderProgressLog->GeographicUnitOfMeasurement_Code | string | |\r\n| permissionTreeId | WorkOrderProgressLog->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderProgressLog->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderProgressLog->PermissionTree_Description | string | |\r\n| id | WorkOrderProgressLog->Id | integer | int64 |\r\n| version | WorkOrderProgressLog->Version | integer | int32 |\r\n| executedOn | WorkOrderProgressLog->ExecutedOn | string | date-time |\r\n| freeTextReason | WorkOrderProgressLog->FreeTextReason | string | |\r\n| workOrderStatusChangeId | WorkOrderProgressLog->WorkOrderStatusChange_Id | integer | int64 |\r\n| workOrderStatusChangeRemark | WorkOrderProgressLog->WorkOrderStatusChange_Remark | string | |\r\n| workOrderStatusChangeNewStatusId | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Id | integer | int64 |\r\n| workOrderStatusChangeNewStatusCode | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code | string | |\r\n| workOrderStatusChangeNewStatusDescription | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description | string | |\r\n| workOrderStatusChangeWorkOrderId | WorkOrderProgressLog->WorkOrderStatusChange_WorkOrder_Id | integer | int64 |\r\n| workOrderStatusChangeWorkOrderCode | WorkOrderProgressLog->WorkOrderStatusChange_WorkOrder_Code | string | |\r\n| notes | WorkOrderProgressLog->Notes | string | |\r\n| preConfiguredReasonId | WorkOrderProgressLog->PreConfiguredReason_Id | integer | int64 |\r\n| preConfiguredReasonCode | WorkOrderProgressLog->PreConfiguredReason_Code | string | |\r\n| preConfiguredReasonDescription | WorkOrderProgressLog->PreConfiguredReason_Description | string | |\r\n| progressEventId | WorkOrderProgressLog->ProgressEvent_Id | integer | int64 |\r\n| progressEventCode | WorkOrderProgressLog->ProgressEvent_Code | string | |\r\n| progressEventDescription | WorkOrderProgressLog->ProgressEvent_Description | string | |\r\n| workOrderId | WorkOrderProgressLog->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderProgressLog->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderProgressLog->WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderProgressLog", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Progress Log Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Progress Log", "schema": { "$ref": "#/definitions/GetWorkOrderProgressLogResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{workOrderId}/ProgressLog": { "get": { "tags": [ "Work Order Progress Log" ], "summary": "Get a collection of Work Order Progress Log resources for the Work Order.", "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 | WorkOrderProgressLog->Id | integer | int64 |\r\n| version | WorkOrderProgressLog->Version | integer | int32 |\r\n| progressEventCode | WorkOrderProgressLog->ProgressEvent_Code | string | |\r\n| progressEventDescription | WorkOrderProgressLog->ProgressEvent_Description | string | |\r\n| createdByUserFullName | WorkOrderProgressLog->CreatedByUser_FullName | string | |\r\n| executedOn | WorkOrderProgressLog->ExecutedOn | string | date-time |\r\n| freeTextReason | WorkOrderProgressLog->FreeTextReason | string | |\r\n| workOrderStatusChangeNewStatusBaseStatus | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStatusChangeNewStatusCode | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code | string | |\r\n| workOrderStatusChangeNewStatusDescription | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description | string | |\r\n| geographicLocation | WorkOrderProgressLog->GeographicLocation | object | |\r\n", "operationId": "GetWorkOrderProgressLogForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Progress Log collection", "schema": { "$ref": "#/definitions/GetWorkOrderProgressLogCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ProgressLog": { "get": { "tags": [ "Work Order Progress Log" ], "summary": "Get a collection of Work Order Progress Log resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderProgressLog->Id | integer | int64 |\r\n| version | WorkOrderProgressLog->Version | integer | int32 |\r\n| workOrderCode | WorkOrderProgressLog->WorkOrder_Code | string | |\r\n| progressEventCode | WorkOrderProgressLog->ProgressEvent_Code | string | |\r\n| progressEventDescription | WorkOrderProgressLog->ProgressEvent_Description | string | |\r\n| createdByUserFullName | WorkOrderProgressLog->CreatedByUser_FullName | string | |\r\n| executedOn | WorkOrderProgressLog->ExecutedOn | string | date-time |\r\n| createdOn | WorkOrderProgressLog->CreatedOn | string | date-time |\r\n| freeTextReason | WorkOrderProgressLog->FreeTextReason | string | |\r\n| workOrderStatusChangeNewStatusBaseStatus | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderStatusChangeNewStatusCode | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code | string | |\r\n| workOrderStatusChangeNewStatusDescription | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description | string | |\r\n| geographicLocation | WorkOrderProgressLog->GeographicLocation | object | |\r\n", "operationId": "GetWorkOrderProgressLogCollection", "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 Work Order Progress Log collection", "schema": { "$ref": "#/definitions/GetWorkOrderProgressLogCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ProgressLog/Batch/{ids}": { "get": { "tags": [ "Work Order Progress Log" ], "summary": "Get a collection of Work Order Progress Log 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 | WorkOrderProgressLog->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderProgressLog->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderProgressLog->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderProgressLog->CreatedOn | string | date-time |\r\n| geographicId | WorkOrderProgressLog->GeographicId | integer | int64 |\r\n| geographicEndPosition | WorkOrderProgressLog->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | WorkOrderProgressLog->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | WorkOrderProgressLog->GeographicLength | number | decimal |\r\n| geographicLocation | WorkOrderProgressLog->GeographicLocation | object | |\r\n| geographicNotes | WorkOrderProgressLog->GeographicNotes | string | |\r\n| geographicReferenceEntityId | WorkOrderProgressLog->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | WorkOrderProgressLog->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | WorkOrderProgressLog->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkOrderProgressLog->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | WorkOrderProgressLog->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | WorkOrderProgressLog->GeographicUnitOfMeasurement_Code | string | |\r\n| permissionTreeId | WorkOrderProgressLog->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderProgressLog->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderProgressLog->PermissionTree_Description | string | |\r\n| id | WorkOrderProgressLog->Id | integer | int64 |\r\n| version | WorkOrderProgressLog->Version | integer | int32 |\r\n| executedOn | WorkOrderProgressLog->ExecutedOn | string | date-time |\r\n| freeTextReason | WorkOrderProgressLog->FreeTextReason | string | |\r\n| workOrderStatusChangeId | WorkOrderProgressLog->WorkOrderStatusChange_Id | integer | int64 |\r\n| workOrderStatusChangeRemark | WorkOrderProgressLog->WorkOrderStatusChange_Remark | string | |\r\n| workOrderStatusChangeNewStatusId | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Id | integer | int64 |\r\n| workOrderStatusChangeNewStatusCode | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code | string | |\r\n| workOrderStatusChangeNewStatusDescription | WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description | string | |\r\n| workOrderStatusChangeWorkOrderId | WorkOrderProgressLog->WorkOrderStatusChange_WorkOrder_Id | integer | int64 |\r\n| workOrderStatusChangeWorkOrderCode | WorkOrderProgressLog->WorkOrderStatusChange_WorkOrder_Code | string | |\r\n| notes | WorkOrderProgressLog->Notes | string | |\r\n| preConfiguredReasonId | WorkOrderProgressLog->PreConfiguredReason_Id | integer | int64 |\r\n| preConfiguredReasonCode | WorkOrderProgressLog->PreConfiguredReason_Code | string | |\r\n| preConfiguredReasonDescription | WorkOrderProgressLog->PreConfiguredReason_Description | string | |\r\n| progressEventId | WorkOrderProgressLog->ProgressEvent_Id | integer | int64 |\r\n| progressEventCode | WorkOrderProgressLog->ProgressEvent_Code | string | |\r\n| progressEventDescription | WorkOrderProgressLog->ProgressEvent_Description | string | |\r\n| workOrderId | WorkOrderProgressLog->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderProgressLog->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderProgressLog->WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderProgressLog", "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 Work Order Progress Log 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 Work Order Progress Log collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderProgressLogResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements/{id}": { "get": { "tags": [ "Work Order Service Level Agreement" ], "summary": "Get a Work Order Service Level Agreement 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| id | WorkOrderServiceLevelAgreement->Id | integer | int64 |\r\n| version | WorkOrderServiceLevelAgreement->Version | integer | int32 |\r\n| assignedDate | WorkOrderServiceLevelAgreement->AssignedDate | string | date-time |\r\n| calculateFromAssignedDate | WorkOrderServiceLevelAgreement->CalculateFromAssignedDate | boolean | |\r\n| isHistorical | WorkOrderServiceLevelAgreement->IsHistorical | boolean | |\r\n| mainMeasurePercentage | WorkOrderServiceLevelAgreement->MainMeasurePercentage | number | decimal |\r\n| origin | WorkOrderServiceLevelAgreement->Origin | string (Allowed values: [WorkOrderCreate, WorkOrderStatusChange, WorkOrderUpdate, WorkOrderReassign]) | enum |\r\n| serviceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementDescription | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description | string | |\r\n| serviceLevelAgreementTemplateServiceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderId | WorkOrderServiceLevelAgreement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderServiceLevelAgreement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderServiceLevelAgreement->WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderServiceLevelAgreement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Service Level Agreement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Service Level Agreement", "schema": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements": { "get": { "tags": [ "Work Order Service Level Agreement" ], "summary": "Get a collection of Work Order Service Level Agreement 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 | WorkOrderServiceLevelAgreement->Version | integer | int32 |\r\n| id | WorkOrderServiceLevelAgreement->Id | integer | int64 |\r\n| serviceLevelAgreementTemplateServiceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementDescription | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description | string | |\r\n| workOrderId | WorkOrderServiceLevelAgreement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderServiceLevelAgreement->WorkOrder_Code | string | |\r\n| assignedDate | WorkOrderServiceLevelAgreement->AssignedDate | string | date-time |\r\n| mainMeasurePercentage | WorkOrderServiceLevelAgreement->MainMeasurePercentage | number | decimal |\r\n| isHistorical | WorkOrderServiceLevelAgreement->IsHistorical | boolean | |\r\n| origin | WorkOrderServiceLevelAgreement->Origin | string (Allowed values: [WorkOrderCreate, WorkOrderStatusChange, WorkOrderUpdate, WorkOrderReassign]) | enum |\r\n| calculateFromAssignedDate | WorkOrderServiceLevelAgreement->CalculateFromAssignedDate | boolean | |\r\n", "operationId": "GetWorkOrderServiceLevelAgreementCollection", "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 Work Order Service Level Agreement collection", "schema": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{id}/ServiceLevelAgreements": { "get": { "tags": [ "Work Order Service Level Agreement" ], "summary": "Get a collection of Work Order Service Level Agreement 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 | WorkOrderServiceLevelAgreement->Version | integer | int32 |\r\n| id | WorkOrderServiceLevelAgreement->Id | integer | int64 |\r\n| serviceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementTemplateServiceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementDescription | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description | string | |\r\n| assignedDate | WorkOrderServiceLevelAgreement->AssignedDate | string | date-time |\r\n| mainMeasurePercentage | WorkOrderServiceLevelAgreement->MainMeasurePercentage | number | decimal |\r\n| isHistorical | WorkOrderServiceLevelAgreement->IsHistorical | boolean | |\r\n| origin | WorkOrderServiceLevelAgreement->Origin | string (Allowed values: [WorkOrderCreate, WorkOrderStatusChange, WorkOrderUpdate, WorkOrderReassign]) | enum |\r\n| calculateFromAssignedDate | WorkOrderServiceLevelAgreement->CalculateFromAssignedDate | boolean | |\r\n", "operationId": "GetWorkOrderServiceLevelAgreementForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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 Work Order Service Level Agreement collection", "schema": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements/Batch/{ids}": { "get": { "tags": [ "Work Order Service Level Agreement" ], "summary": "Get a collection of Work Order Service Level Agreement 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| id | WorkOrderServiceLevelAgreement->Id | integer | int64 |\r\n| version | WorkOrderServiceLevelAgreement->Version | integer | int32 |\r\n| assignedDate | WorkOrderServiceLevelAgreement->AssignedDate | string | date-time |\r\n| calculateFromAssignedDate | WorkOrderServiceLevelAgreement->CalculateFromAssignedDate | boolean | |\r\n| isHistorical | WorkOrderServiceLevelAgreement->IsHistorical | boolean | |\r\n| mainMeasurePercentage | WorkOrderServiceLevelAgreement->MainMeasurePercentage | number | decimal |\r\n| origin | WorkOrderServiceLevelAgreement->Origin | string (Allowed values: [WorkOrderCreate, WorkOrderStatusChange, WorkOrderUpdate, WorkOrderReassign]) | enum |\r\n| serviceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Id | integer | int64 |\r\n| serviceLevelAgreementCode | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementDescription | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description | string | |\r\n| serviceLevelAgreementTemplateServiceLevelAgreementId | WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderId | WorkOrderServiceLevelAgreement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderServiceLevelAgreement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderServiceLevelAgreement->WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderServiceLevelAgreement", "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 Work Order Service Level Agreement 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 Work Order Service Level Agreement collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderServiceLevelAgreementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements/Measures/{id}": { "get": { "tags": [ "Work Order Service Level Agreement Measure" ], "summary": "Get a Work Order Service Level Agreement Measure 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| id | WorkOrderServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| version | WorkOrderServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| completeDate | WorkOrderServiceLevelAgreementMeasure->CompleteDate | string | date-time |\r\n| durationUsed | WorkOrderServiceLevelAgreementMeasure->DurationUsed | string | duration |\r\n| durationUsedPercentage | WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage | number | decimal |\r\n| errorStatus | WorkOrderServiceLevelAgreementMeasure->ErrorStatus | string | |\r\n| expectedCompleteDate | WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate | string | date-time |\r\n| inStatusRange | WorkOrderServiceLevelAgreementMeasure->InStatusRange | boolean | |\r\n| isHistorical | WorkOrderServiceLevelAgreementMeasure->IsHistorical | boolean | |\r\n| lastCalculatedOn | WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn | string | date-time |\r\n| measureResetDate | WorkOrderServiceLevelAgreementMeasure->MeasureResetDate | string | date-time |\r\n| serviceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description | string | |\r\n| serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| startDate | WorkOrderServiceLevelAgreementMeasure->StartDate | string | date-time |\r\n| workOrderServiceLevelAgreementId | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementId | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementCode | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code | string | |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementDescription | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Description | string | |\r\n", "operationId": "GetWorkOrderServiceLevelAgreementMeasure", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Service Level Agreement Measure Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Service Level Agreement Measure", "schema": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementMeasureResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements/Measures": { "get": { "tags": [ "Work Order Service Level Agreement Measure" ], "summary": "Get a collection of Work Order Service Level Agreement Measure 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 | WorkOrderServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| id | WorkOrderServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| workOrderServiceLevelAgreementId | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderServiceLevelAgreementWorkOrderCode | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_WorkOrder_Code | string | |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementId | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementCode | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code | string | |\r\n| serviceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description | string | |\r\n| serviceLevelAgreementMeasureDuration | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Duration | string | duration |\r\n| serviceLevelAgreementMeasureWorkOrderStartStatusId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderStartStatus_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureWorkOrderStartStatusCode | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderStartStatus_Code | string | |\r\n| serviceLevelAgreementMeasureWorkOrderEndStatusId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderEndStatus_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureWorkOrderEndStatusCode | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderEndStatus_Code | string | |\r\n| inStatusRange | WorkOrderServiceLevelAgreementMeasure->InStatusRange | boolean | |\r\n| startDate | WorkOrderServiceLevelAgreementMeasure->StartDate | string | date-time |\r\n| completeDate | WorkOrderServiceLevelAgreementMeasure->CompleteDate | string | date-time |\r\n| expectedCompleteDate | WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate | string | date-time |\r\n| durationUsed | WorkOrderServiceLevelAgreementMeasure->DurationUsed | string | duration |\r\n| durationUsedPercentage | WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage | number | decimal |\r\n| measureResetDate | WorkOrderServiceLevelAgreementMeasure->MeasureResetDate | string | date-time |\r\n| lastCalculatedOn | WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn | string | date-time |\r\n", "operationId": "GetWorkOrderServiceLevelAgreementMeasureCollection", "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 Work Order Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementMeasureCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements/{id}/Measures": { "get": { "tags": [ "Work Order Service Level Agreement Measure" ], "summary": "Get a collection of Work Order Service Level Agreement Measure 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 | WorkOrderServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| id | WorkOrderServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description | string | |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementCode | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code | string | |\r\n| inStatusRange | WorkOrderServiceLevelAgreementMeasure->InStatusRange | boolean | |\r\n| startDate | WorkOrderServiceLevelAgreementMeasure->StartDate | string | date-time |\r\n| completeDate | WorkOrderServiceLevelAgreementMeasure->CompleteDate | string | date-time |\r\n| expectedCompleteDate | WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate | string | date-time |\r\n| durationUsed | WorkOrderServiceLevelAgreementMeasure->DurationUsed | string | duration |\r\n| durationUsedPercentage | WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage | number | decimal |\r\n| measureResetDate | WorkOrderServiceLevelAgreementMeasure->MeasureResetDate | string | date-time |\r\n| lastCalculatedOn | WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn | string | date-time |\r\n", "operationId": "GetWorkOrderServiceLevelAgreementMeasureForWorkOrderServiceLevelAgreementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Service Level Agreement 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 Work Order Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementMeasureForWorkOrderServiceLevelAgreementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/ServiceLevelAgreements/Measures/Batch/{ids}": { "get": { "tags": [ "Work Order Service Level Agreement Measure" ], "summary": "Get a collection of Work Order Service Level Agreement Measure 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| id | WorkOrderServiceLevelAgreementMeasure->Id | integer | int64 |\r\n| version | WorkOrderServiceLevelAgreementMeasure->Version | integer | int32 |\r\n| completeDate | WorkOrderServiceLevelAgreementMeasure->CompleteDate | string | date-time |\r\n| durationUsed | WorkOrderServiceLevelAgreementMeasure->DurationUsed | string | duration |\r\n| durationUsedPercentage | WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage | number | decimal |\r\n| errorStatus | WorkOrderServiceLevelAgreementMeasure->ErrorStatus | string | |\r\n| expectedCompleteDate | WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate | string | date-time |\r\n| inStatusRange | WorkOrderServiceLevelAgreementMeasure->InStatusRange | boolean | |\r\n| isHistorical | WorkOrderServiceLevelAgreementMeasure->IsHistorical | boolean | |\r\n| lastCalculatedOn | WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn | string | date-time |\r\n| measureResetDate | WorkOrderServiceLevelAgreementMeasure->MeasureResetDate | string | date-time |\r\n| serviceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| serviceLevelAgreementMeasureCode | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code | string | |\r\n| serviceLevelAgreementMeasureDescription | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description | string | |\r\n| serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId | WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id | integer | int64 |\r\n| startDate | WorkOrderServiceLevelAgreementMeasure->StartDate | string | date-time |\r\n| workOrderServiceLevelAgreementId | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementId | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Id | integer | int64 |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementCode | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code | string | |\r\n| workOrderServiceLevelAgreementServiceLevelAgreementDescription | WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Description | string | |\r\n", "operationId": "BatchGetWorkOrderServiceLevelAgreementMeasure", "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 Work Order Service Level Agreement Measure 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 Work Order Service Level Agreement Measure collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderServiceLevelAgreementMeasureResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/{id}": { "get": { "tags": [ "Work Order Status" ], "summary": "Get a Work Order Status 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 | WorkOrderStatus->Code | string | |\r\n| isActive | WorkOrderStatus->IsActive | boolean | |\r\n| createdByUserId | WorkOrderStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatus->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatus->ModifiedOn | string | date-time |\r\n| version | WorkOrderStatus->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatus->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatus->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatus->PermissionTree_Description | string | |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| description | WorkOrderStatus->Description | string | |\r\n| notes | WorkOrderStatus->Notes | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| statusClassificationId | WorkOrderStatus->StatusClassification_Id | integer | int64 |\r\n| statusClassificationCode | WorkOrderStatus->StatusClassification_Code | string | |\r\n| statusClassificationDescription | WorkOrderStatus->StatusClassification_Description | string | |\r\n", "operationId": "GetWorkOrderStatus", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Status", "schema": { "$ref": "#/definitions/GetWorkOrderStatusResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Status" ], "summary": "Update an existing Work Order Status 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 | WorkOrderStatus->Version | integer | int32 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| statusClassificationId | WorkOrderStatus->StatusClassification_Id | integer | int64 |\r\n| notes | WorkOrderStatus->Notes | string | |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | 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| 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": "UpdateWorkOrderStatus", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status" ], "summary": "Delete an existing Work Order Status 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 | WorkOrderStatus->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": "DeleteWorkOrderStatus", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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/WM/WorkOrderStatuses": { "get": { "tags": [ "Work Order Status" ], "summary": "Get a collection of Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| version | WorkOrderStatus->Version | integer | int32 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n| isActive | WorkOrderStatus->IsActive | boolean | |\r\n", "operationId": "GetWorkOrderStatusCollection", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Status" ], "summary": "Create a new Work Order Status 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 | WorkOrderStatus->PermissionTree_Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n| statusClassificationId | WorkOrderStatus->StatusClassification_Id | integer | int64 |\r\n| notes | WorkOrderStatus->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| baseStatus | Required | True | |\r\n| baseStatus | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderStatus", "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/CreateWorkOrderStatusResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Lookups/LookupWorkOrderStatusChangePermissionTree": { "get": { "tags": [ "Work Order Status" ], "summary": "Lookup the permission set for changing the Work Order Status.", "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": "LookupWorkOrderStatusChangePermissionTree", "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/WorkOrderStatusChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Lookups/LookupWorkOrderStatusInsertPermissionTree": { "get": { "tags": [ "Work Order Status" ], "summary": "Lookup the permission set for creating the Work Order Status.", "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": "LookupWorkOrderStatusInsertPermissionTree", "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/WorkOrderStatusInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Lookups/LookupWorkOrderStatusStatusClassification": { "get": { "tags": [ "Work Order Status" ], "summary": "Lookup the Classification for the Work Order Status.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderStatusStatusClassification", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderStatusStatusClassificationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Batch/{ids}": { "get": { "tags": [ "Work Order Status" ], "summary": "Get a collection of Work Order Status 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 | WorkOrderStatus->Code | string | |\r\n| isActive | WorkOrderStatus->IsActive | boolean | |\r\n| createdByUserId | WorkOrderStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatus->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatus->ModifiedOn | string | date-time |\r\n| version | WorkOrderStatus->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatus->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatus->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatus->PermissionTree_Description | string | |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| description | WorkOrderStatus->Description | string | |\r\n| notes | WorkOrderStatus->Notes | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| statusClassificationId | WorkOrderStatus->StatusClassification_Id | integer | int64 |\r\n| statusClassificationCode | WorkOrderStatus->StatusClassification_Code | string | |\r\n| statusClassificationDescription | WorkOrderStatus->StatusClassification_Description | string | |\r\n", "operationId": "BatchGetWorkOrderStatus", "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 Work Order Status 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 Work Order Status collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderStatusResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Batch": { "post": { "tags": [ "Work Order Status" ], "summary": "Create a new collection of Work Order Status 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 | WorkOrderStatus->PermissionTree_Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| notes | WorkOrderStatus->Notes | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n| statusClassificationId | WorkOrderStatus->StatusClassification_Id | integer | int64 |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | 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| 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| baseStatus | Required | True | |\r\n| baseStatus | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderStatus", "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/BatchCreateWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status" ], "summary": "Update a collection of existing Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| version | WorkOrderStatus->Version | integer | int32 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| sequenceNumber | WorkOrderStatus->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatus->Notes | string | |\r\n| statusClassificationId | WorkOrderStatus->StatusClassification_Id | integer | int64 |\r\n| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | 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| 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": "BatchUpdateWorkOrderStatus", "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/BatchUpdateWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status" ], "summary": "Delete a collection of existing Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| version | WorkOrderStatus->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": "BatchDeleteWorkOrderStatus", "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/BatchDeleteWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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/WM/WorkOrderStatuses/{id}/Active": { "patch": { "tags": [ "Work Order Status" ], "summary": "Change the IsActive status for an existing Work Order Status 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 | WorkOrderStatus->Version | integer | int32 |\r\n| isActive | WorkOrderStatus->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": "ChangeWorkOrderStatusIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Status" ], "summary": "Change the PermissionTree for an existing Work Order Status 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 | WorkOrderStatus->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatus->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": "ChangeWorkOrderStatusPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Batch/Active": { "patch": { "tags": [ "Work Order Status" ], "summary": "Change the IsActive status for a collection of existing Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| version | WorkOrderStatus->Version | integer | int32 |\r\n| isActive | WorkOrderStatus->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": "BatchChangeWorkOrderStatusIsActive", "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/BatchChangeWorkOrderStatusIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Status" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| version | WorkOrderStatus->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatus->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": "BatchChangeWorkOrderStatusPermissionTree", "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/BatchChangeWorkOrderStatusPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/AllowedChanges/{id}": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Get a Work Order Status Allowed Change resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | WorkOrderStatusAllowedChange->IsActive | boolean | |\r\n| createdByUserId | WorkOrderStatusAllowedChange->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusAllowedChange->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusAllowedChange->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusAllowedChange->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderStatusAllowedChange->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatusAllowedChange->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatusAllowedChange->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatusAllowedChange->ModifiedOn | string | date-time |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusAllowedChange->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatusAllowedChange->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatusAllowedChange->PermissionTree_Description | string | |\r\n| id | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| notes | WorkOrderStatusAllowedChange->Notes | string | |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| workOrderAllowedStatusCode | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code | string | |\r\n| workOrderAllowedStatusDescription | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description | string | |\r\n| workOrderStatusId | WorkOrderStatusAllowedChange->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusAllowedChange->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusAllowedChange->WorkOrderStatus_Description | string | |\r\n", "operationId": "GetWorkOrderStatusAllowedChange", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Allowed Change Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Status Allowed Change", "schema": { "$ref": "#/definitions/GetWorkOrderStatusAllowedChangeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Update an existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| notes | WorkOrderStatusAllowedChange->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| workOrderAllowedStatusId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderStatusAllowedChange", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderStatusAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status Allowed Change 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": [ "Work Order Status Allowed Change" ], "summary": "Delete an existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->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": "DeleteWorkOrderStatusAllowedChange", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderStatusAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status Allowed Change 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/WM/WorkOrderStatuses/AllowedChanges": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Get a collection of Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| workOrderStatusId | WorkOrderStatusAllowedChange->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusAllowedChange->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusAllowedChange->WorkOrderStatus_Description | string | |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| workOrderAllowedStatusCode | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code | string | |\r\n| workOrderAllowedStatusDescription | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description | string | |\r\n| isActive | WorkOrderStatusAllowedChange->IsActive | boolean | |\r\n", "operationId": "GetWorkOrderStatusAllowedChangeCollection", "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 Work Order Status Allowed Change collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusAllowedChangeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Create a new Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->PermissionTree_Id | integer | int64 |\r\n| workOrderStatusId | WorkOrderStatusAllowedChange->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| notes | WorkOrderStatusAllowedChange->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | Nullable | False | |\r\n| workOrderAllowedStatusId | Required | True | |\r\n| workOrderAllowedStatusId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderStatusAllowedChange", "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/CreateWorkOrderStatusAllowedChangeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/{workOrderStatusId}/AllowedChanges": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Get a collection of Work Order Status Allowed Change resources for the Work Order Status.", "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 | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| workOrderAllowedStatusCode | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code | string | |\r\n| workOrderAllowedStatusDescription | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description | string | |\r\n| isActive | WorkOrderStatusAllowedChange->IsActive | boolean | |\r\n| notes | WorkOrderStatusAllowedChange->Notes | string | |\r\n", "operationId": "GetWorkOrderStatusAllowedChangeForWorkOrderStatusCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderStatusId", "in": "path", "required": true, "description": "Work Order Status 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 Work Order Status Allowed Change collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusAllowedChangeForWorkOrderStatusCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/AllowedChanges/Lookups/LookupWorkOrderStatusAllowedChangeChangePermissionTree": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Lookup the permission set for changing the Work Order Status Allowed Change.", "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": "LookupWorkOrderStatusAllowedChangeChangePermissionTree", "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/WorkOrderStatusAllowedChangeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/AllowedChanges/Lookups/LookupWorkOrderStatusAllowedChangeInsertPermissionTree": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Lookup the permission set for creating the Work Order Status Allowed Change.", "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": "LookupWorkOrderStatusAllowedChangeInsertPermissionTree", "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/WorkOrderStatusAllowedChangeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/AllowedChanges/Lookups/LookupWorkOrderStatusAllowedChangeWorkOrderAllowedStatus": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Lookup the Work Order Status for the Work Order Status Allowed Change.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupWorkOrderStatusAllowedChangeWorkOrderAllowedStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/WorkOrderStatusAllowedChangeWorkOrderAllowedStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/AllowedChanges/Lookups/LookupWorkOrderStatusAllowedChangeWorkOrderStatus": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Lookup the Work Order Status for the Work Order Status Allowed Change.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupWorkOrderStatusAllowedChangeWorkOrderStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/WorkOrderStatusAllowedChangeWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/AllowedChanges/Batch/{ids}": { "get": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Get a collection of Work Order Status Allowed Change resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | WorkOrderStatusAllowedChange->IsActive | boolean | |\r\n| createdByUserId | WorkOrderStatusAllowedChange->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusAllowedChange->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusAllowedChange->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusAllowedChange->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderStatusAllowedChange->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatusAllowedChange->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatusAllowedChange->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatusAllowedChange->ModifiedOn | string | date-time |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusAllowedChange->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatusAllowedChange->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatusAllowedChange->PermissionTree_Description | string | |\r\n| id | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| notes | WorkOrderStatusAllowedChange->Notes | string | |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| workOrderAllowedStatusCode | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code | string | |\r\n| workOrderAllowedStatusDescription | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description | string | |\r\n| workOrderStatusId | WorkOrderStatusAllowedChange->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusAllowedChange->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusAllowedChange->WorkOrderStatus_Description | string | |\r\n", "operationId": "BatchGetWorkOrderStatusAllowedChange", "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 Work Order Status Allowed Change 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 Work Order Status Allowed Change collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderStatusAllowedChangeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/AllowedChanges/Batch": { "post": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Create a new collection of Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->PermissionTree_Id | integer | int64 |\r\n| workOrderStatusId | WorkOrderStatusAllowedChange->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| notes | WorkOrderStatusAllowedChange->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | Nullable | False | |\r\n| workOrderAllowedStatusId | Required | True | |\r\n| workOrderAllowedStatusId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderStatusAllowedChange", "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/BatchCreateWorkOrderStatusAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Status Allowed Change 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": [ "Work Order Status Allowed Change" ], "summary": "Update a collection of existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| workOrderAllowedStatusId | WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id | integer | int64 |\r\n| notes | WorkOrderStatusAllowedChange->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| workOrderAllowedStatusId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderStatusAllowedChange", "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/BatchUpdateWorkOrderStatusAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status Allowed Change 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": [ "Work Order Status Allowed Change" ], "summary": "Delete a collection of existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderStatusAllowedChange->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": "BatchDeleteWorkOrderStatusAllowedChange", "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/BatchDeleteWorkOrderStatusAllowedChangeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status Allowed Change 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/WM/WorkOrderStatuses/AllowedChanges/{id}/Active": { "patch": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Change the IsActive status for an existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| isActive | WorkOrderStatusAllowedChange->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": "ChangeWorkOrderStatusAllowedChangeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/AllowedChanges/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Change the PermissionTree for an existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusAllowedChange->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": "ChangeWorkOrderStatusAllowedChangePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Allowed Change Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/AllowedChanges/Batch/Active": { "patch": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Change the IsActive status for a collection of existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| isActive | WorkOrderStatusAllowedChange->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": "BatchChangeWorkOrderStatusAllowedChangeIsActive", "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/BatchChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/AllowedChanges/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Status Allowed Change" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Status Allowed Change 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 | WorkOrderStatusAllowedChange->Id | integer | int64 |\r\n| version | WorkOrderStatusAllowedChange->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusAllowedChange->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": "BatchChangeWorkOrderStatusAllowedChangePermissionTree", "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/BatchChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Attributes/{id}": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Get a Work Order Status 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| workOrderStatusId | WorkOrderStatusAttribute->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusAttribute->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusAttribute->WorkOrderStatus_Description | string | |\r\n| createdByUserId | WorkOrderStatusAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusAttribute->CreatedOn | string | date-time |\r\n| isActive | WorkOrderStatusAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderStatusAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatusAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatusAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatusAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatusAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatusAttribute->PermissionTree_Description | string | |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| id | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| attributeId | WorkOrderStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderStatusAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WorkOrderStatusAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WorkOrderStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WorkOrderStatusAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WorkOrderStatusAttribute->Notes | string | |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderStatusAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n", "operationId": "GetWorkOrderStatusAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Status Attribute", "schema": { "$ref": "#/definitions/GetWorkOrderStatusAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Status Attribute" ], "summary": "Update an existing Work Order Status 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 | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusAttribute->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": "UpdateWorkOrderStatusAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderStatusAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status Attribute" ], "summary": "Delete an existing Work Order Status 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 | WorkOrderStatusAttribute->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": "DeleteWorkOrderStatusAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderStatusAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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/WM/WorkOrderStatuses/{workOrderStatusId}/Attributes": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Get a collection of Work Order Status Attribute resources for the Work Order Status.", "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 | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WorkOrderStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderStatusAttribute->Attribute_Description | string | |\r\n| attributeDataType | WorkOrderStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderStatusAttribute->PredefinedValue_Value | object | composite |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n| notes | WorkOrderStatusAttribute->Notes | string | |\r\n| createdOn | WorkOrderStatusAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderStatusAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderStatusAttributeCollectionForWorkOrderStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderStatusId", "in": "path", "required": true, "description": "Work Order Status 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 Work Order Status Attribute collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusAttributeCollectionForWorkOrderStatusResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Get a collection of Work Order Status 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 | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| workOrderStatusId | WorkOrderStatusAttribute->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusAttribute->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusAttribute->WorkOrderStatus_Description | string | |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WorkOrderStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderStatusAttribute->Attribute_Description | string | |\r\n| attributeDataType | WorkOrderStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderStatusAttribute->PredefinedValue_Value | object | composite |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n| notes | WorkOrderStatusAttribute->Notes | string | |\r\n| createdOn | WorkOrderStatusAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderStatusAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderStatusAttributeCollection", "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 Work Order Status Attribute collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Status Attribute" ], "summary": "Create a new Work Order Status 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| workOrderStatusId | WorkOrderStatusAttribute->WorkOrderStatus_Id | integer | int64 |\r\n| attributeId | WorkOrderStatusAttribute->Attribute_Id | integer | int64 |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusAttribute->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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | 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": "CreateWorkOrderStatusAttribute", "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/CreateWorkOrderStatusAttributeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Attributes/Lookups/LookupWorkOrderStatusAttributeAllowedValue": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Work Order Status 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": "LookupWorkOrderStatusAttributeAllowedValue", "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/WorkOrderStatusAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes/Lookups/LookupWorkOrderStatusAttribute": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Work Order Status 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": "LookupWorkOrderStatusAttribute", "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/WorkOrderStatusAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes/Lookups/LookupWorkOrderStatusAttributeChangePermissionTree": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Lookup the permission set for changing the Work Order Status 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": "LookupWorkOrderStatusAttributeChangePermissionTree", "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/WorkOrderStatusAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes/Lookups/LookupWorkOrderStatusAttributeInsertPermissionTree": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Lookup the permission set for creating the Work Order Status 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": "LookupWorkOrderStatusAttributeInsertPermissionTree", "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/WorkOrderStatusAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes/Lookups/LookupWorkOrderStatusAttributeWorkOrderStatus": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Lookup the Work Order Status Attribute for the Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupWorkOrderStatusAttributeWorkOrderStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/WorkOrderStatusAttributeWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes/Batch/{ids}": { "get": { "tags": [ "Work Order Status Attribute" ], "summary": "Get a collection of Work Order Status 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| workOrderStatusId | WorkOrderStatusAttribute->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusAttribute->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusAttribute->WorkOrderStatus_Description | string | |\r\n| createdByUserId | WorkOrderStatusAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusAttribute->CreatedOn | string | date-time |\r\n| isActive | WorkOrderStatusAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderStatusAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatusAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatusAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatusAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatusAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatusAttribute->PermissionTree_Description | string | |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| id | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| attributeId | WorkOrderStatusAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkOrderStatusAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkOrderStatusAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WorkOrderStatusAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WorkOrderStatusAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WorkOrderStatusAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WorkOrderStatusAttribute->Notes | string | |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkOrderStatusAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkOrderStatusAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n", "operationId": "BatchGetWorkOrderStatusAttribute", "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 Work Order Status 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 Work Order Status Attribute collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderStatusAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Attributes/Batch": { "post": { "tags": [ "Work Order Status Attribute" ], "summary": "Create a new collection of Work Order Status 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| workOrderStatusId | WorkOrderStatusAttribute->WorkOrderStatus_Id | integer | int64 |\r\n| attributeId | WorkOrderStatusAttribute->Attribute_Id | integer | int64 |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderStatusAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusAttribute->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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | 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": "BatchCreateWorkOrderStatusAttribute", "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/BatchCreateWorkOrderStatusAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status Attribute" ], "summary": "Update a collection of existing Work Order Status 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 | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| value | WorkOrderStatusAttribute->Value | object | composite |\r\n| predefinedValueId | WorkOrderStatusAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderStatusAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusAttribute->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": "BatchUpdateWorkOrderStatusAttribute", "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/BatchUpdateWorkOrderStatusAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status Attribute" ], "summary": "Delete a collection of existing Work Order Status 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 | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| version | WorkOrderStatusAttribute->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": "BatchDeleteWorkOrderStatusAttribute", "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/BatchDeleteWorkOrderStatusAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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/WM/WorkOrderStatuses/Attributes/{id}/Active": { "patch": { "tags": [ "Work Order Status Attribute" ], "summary": "Change the IsActive status for an existing Work Order Status 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 | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| isActive | WorkOrderStatusAttribute->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": "ChangeWorkOrderStatusAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusAttributeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Status Attribute" ], "summary": "Change the PermissionTree for an existing Work Order Status 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 | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusAttribute->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": "ChangeWorkOrderStatusAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Status Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Status 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 | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusAttribute->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": "BatchChangeWorkOrderStatusAttributePermissionTree", "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/BatchChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Attributes/Batch/Active": { "patch": { "tags": [ "Work Order Status Attribute" ], "summary": "Change the IsActive status for a collection of existing Work Order Status 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 | WorkOrderStatusAttribute->Id | integer | int64 |\r\n| version | WorkOrderStatusAttribute->Version | integer | int32 |\r\n| isActive | WorkOrderStatusAttribute->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": "BatchChangeWorkOrderStatusAttributeIsActive", "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/BatchChangeWorkOrderStatusAttributeIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/StatusChangeHistory/{id}": { "get": { "tags": [ "Work Order Status Change History" ], "summary": "Get a Work Order Status Change History 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 | WorkOrderStatusChangeHistory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusChangeHistory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusChangeHistory->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusChangeHistory->CreatedOn | string | date-time |\r\n| id | WorkOrderStatusChangeHistory->Id | integer | int64 |\r\n| version | WorkOrderStatusChangeHistory->Version | integer | int32 |\r\n| elapsedTime | WorkOrderStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | WorkOrderStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkOrderStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkOrderStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkOrderStatusChangeHistory->NewStatus_Description | string | |\r\n| offlineStatusChangedOn | WorkOrderStatusChangeHistory->OfflineStatusChangedOn | string | date-time |\r\n| oldStatusId | WorkOrderStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkOrderStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkOrderStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkOrderStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorWorkOrderId | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Id | integer | int64 |\r\n| predecessorWorkOrderCode | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code | string | |\r\n| predecessorWorkOrderDescription | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description | string | |\r\n| predecessorWorkOrderWorkRequired | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_WorkRequired | string | |\r\n| predecessorWorkOrderSiteId | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Site_Id | integer | int64 |\r\n| predecessorWorkOrderSiteCode | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Site_Code | string | |\r\n| remark | WorkOrderStatusChangeHistory->Remark | string | |\r\n| workOrderId | WorkOrderStatusChangeHistory->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderStatusChangeHistory->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderStatusChangeHistory->WorkOrder_Description | string | |\r\n| workOrderWorkRequired | WorkOrderStatusChangeHistory->WorkOrder_WorkRequired | string | |\r\n| workOrderSiteId | WorkOrderStatusChangeHistory->WorkOrder_Site_Id | integer | int64 |\r\n| workOrderSiteCode | WorkOrderStatusChangeHistory->WorkOrder_Site_Code | string | |\r\n", "operationId": "GetWorkOrderStatusChangeHistory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Change History Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Status Change History", "schema": { "$ref": "#/definitions/GetWorkOrderStatusChangeHistoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{workOrderId}/StatusChangeHistory": { "get": { "tags": [ "Work Order Status Change History" ], "summary": "Get a collection of Work Order Status Change History resources for the Work Order.", "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 | WorkOrderStatusChangeHistory->Id | integer | int64 |\r\n| elapsedTime | WorkOrderStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | WorkOrderStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkOrderStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkOrderStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkOrderStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | WorkOrderStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkOrderStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkOrderStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkOrderStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorWorkOrderCode | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code | string | |\r\n| predecessorWorkOrderDescription | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description | string | |\r\n| remark | WorkOrderStatusChangeHistory->Remark | string | |\r\n| createdOn | WorkOrderStatusChangeHistory->CreatedOn | string | date-time |\r\n| createdByUserCode | WorkOrderStatusChangeHistory->CreatedByUser_Code | string | |\r\n", "operationId": "GetWorkOrderStatusChangeHistoryCollectionForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Status Change History collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusChangeHistoryCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/StatusChangeHistory": { "get": { "tags": [ "Work Order Status Change History" ], "summary": "Get a collection of Work Order Status Change History 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 | WorkOrderStatusChangeHistory->Id | integer | int64 |\r\n| elapsedTime | WorkOrderStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | WorkOrderStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkOrderStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkOrderStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkOrderStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | WorkOrderStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkOrderStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkOrderStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkOrderStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorWorkOrderCode | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code | string | |\r\n| predecessorWorkOrderDescription | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description | string | |\r\n| remark | WorkOrderStatusChangeHistory->Remark | string | |\r\n| createdOn | WorkOrderStatusChangeHistory->CreatedOn | string | date-time |\r\n| createdByUserCode | WorkOrderStatusChangeHistory->CreatedByUser_Code | string | |\r\n| workOrderId | WorkOrderStatusChangeHistory->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderStatusChangeHistory->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderStatusChangeHistory->WorkOrder_Description | string | |\r\n| workOrderWorkRequired | WorkOrderStatusChangeHistory->WorkOrder_WorkRequired | string | |\r\n| workOrderPermissionTreeCode | WorkOrderStatusChangeHistory->WorkOrder_PermissionTree_Code | string | |\r\n| workOrderPermissionTreeDescription | WorkOrderStatusChangeHistory->WorkOrder_PermissionTree_Description | string | |\r\n| workOrderSiteCode | WorkOrderStatusChangeHistory->WorkOrder_Site_Code | string | |\r\n| workOrderSiteDescription | WorkOrderStatusChangeHistory->WorkOrder_Site_Description | string | |\r\n", "operationId": "GetWorkOrderStatusChangeHistoryCollection", "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 Work Order Status Change History collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusChangeHistoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/StatusChangeHistory/Batch/{ids}": { "get": { "tags": [ "Work Order Status Change History" ], "summary": "Get a collection of Work Order Status Change History 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 | WorkOrderStatusChangeHistory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusChangeHistory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusChangeHistory->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusChangeHistory->CreatedOn | string | date-time |\r\n| id | WorkOrderStatusChangeHistory->Id | integer | int64 |\r\n| version | WorkOrderStatusChangeHistory->Version | integer | int32 |\r\n| elapsedTime | WorkOrderStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | WorkOrderStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkOrderStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkOrderStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkOrderStatusChangeHistory->NewStatus_Description | string | |\r\n| offlineStatusChangedOn | WorkOrderStatusChangeHistory->OfflineStatusChangedOn | string | date-time |\r\n| oldStatusId | WorkOrderStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkOrderStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkOrderStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkOrderStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorWorkOrderId | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Id | integer | int64 |\r\n| predecessorWorkOrderCode | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code | string | |\r\n| predecessorWorkOrderDescription | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description | string | |\r\n| predecessorWorkOrderWorkRequired | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_WorkRequired | string | |\r\n| predecessorWorkOrderSiteId | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Site_Id | integer | int64 |\r\n| predecessorWorkOrderSiteCode | WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Site_Code | string | |\r\n| remark | WorkOrderStatusChangeHistory->Remark | string | |\r\n| workOrderId | WorkOrderStatusChangeHistory->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderStatusChangeHistory->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderStatusChangeHistory->WorkOrder_Description | string | |\r\n| workOrderWorkRequired | WorkOrderStatusChangeHistory->WorkOrder_WorkRequired | string | |\r\n| workOrderSiteId | WorkOrderStatusChangeHistory->WorkOrder_Site_Id | integer | int64 |\r\n| workOrderSiteCode | WorkOrderStatusChangeHistory->WorkOrder_Site_Code | string | |\r\n", "operationId": "BatchGetWorkOrderStatusChangeHistory", "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 Work Order Status Change History 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 Work Order Status Change History collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderStatusChangeHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents/{id}": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Get a Work Order Status 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| workOrderStatusId | WorkOrderStatusDocument->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusDocument->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusDocument->WorkOrderStatus_Description | string | |\r\n| isActive | WorkOrderStatusDocument->IsActive | boolean | |\r\n| createdByUserId | WorkOrderStatusDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderStatusDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatusDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatusDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatusDocument->ModifiedOn | string | date-time |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatusDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatusDocument->PermissionTree_Description | string | |\r\n| id | WorkOrderStatusDocument->Id | integer | int64 |\r\n| documentRecordId | WorkOrderStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkOrderStatusDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkOrderStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkOrderStatusDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkOrderStatusDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkOrderStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkOrderStatusDocument->Notes | string | |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWorkOrderStatusDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Status Document", "schema": { "$ref": "#/definitions/GetWorkOrderStatusDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Status Document" ], "summary": "Update an existing Work Order Status 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 | WorkOrderStatusDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusDocument->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": "UpdateWorkOrderStatusDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderStatusDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status Document" ], "summary": "Delete an existing Work Order Status 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 | WorkOrderStatusDocument->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": "DeleteWorkOrderStatusDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderStatusDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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/WM/WorkOrderStatuses/{id}/Documents": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Get a collection of Work Order Status Document resources for the Work Order Status.", "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 | WorkOrderStatusDocument->Id | integer | int64 |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkOrderStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkOrderStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkOrderStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetWorkOrderStatusDocumentCollectionForWorkOrderStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status 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 Work Order Status Document collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusDocumentCollectionForWorkOrderStatusResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Get a collection of Work Order Status 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 | WorkOrderStatusDocument->Id | integer | int64 |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| workOrderStatusId | WorkOrderStatusDocument->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusDocument->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusDocument->WorkOrderStatus_Description | string | |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkOrderStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkOrderStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkOrderStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetWorkOrderStatusDocumentCollection", "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 Work Order Status Document collection", "schema": { "$ref": "#/definitions/GetWorkOrderStatusDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Status Document" ], "summary": "Create a new Work Order Status 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| workOrderStatusId | WorkOrderStatusDocument->WorkOrderStatus_Id | integer | int64 |\r\n| documentRecordId | WorkOrderStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderStatusDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusDocument->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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | 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": "CreateWorkOrderStatusDocument", "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/CreateWorkOrderStatusDocumentResourceActionRequest" } }, { "$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/WM/WorkOrderStatuses/Documents/Lookups/LookupWorkOrderStatusDocumentChangePermissionTree": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Lookup the permission set for changing the Work Order Status 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": "LookupWorkOrderStatusDocumentChangePermissionTree", "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/WorkOrderStatusDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents/Lookups/LookupWorkOrderStatusDocument": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Work Order Status Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupWorkOrderStatusDocument", "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/WorkOrderStatusDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents/Lookups/LookupWorkOrderStatusDocumentInsertPermissionTree": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Lookup the permission set for creating the Work Order Status 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": "LookupWorkOrderStatusDocumentInsertPermissionTree", "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/WorkOrderStatusDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents/Lookups/LookupWorkOrderStatusDocumentWorkOrderStatus": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Lookup the Work Order Status Document for the Work Order Status 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 | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupWorkOrderStatusDocumentWorkOrderStatus", "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 Work Order Status collection", "schema": { "$ref": "#/definitions/WorkOrderStatusDocumentWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents/Batch/{ids}": { "get": { "tags": [ "Work Order Status Document" ], "summary": "Get a collection of Work Order Status 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| workOrderStatusId | WorkOrderStatusDocument->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderStatusDocument->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | WorkOrderStatusDocument->WorkOrderStatus_Description | string | |\r\n| isActive | WorkOrderStatusDocument->IsActive | boolean | |\r\n| createdByUserId | WorkOrderStatusDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderStatusDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderStatusDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderStatusDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderStatusDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderStatusDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderStatusDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderStatusDocument->ModifiedOn | string | date-time |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderStatusDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderStatusDocument->PermissionTree_Description | string | |\r\n| id | WorkOrderStatusDocument->Id | integer | int64 |\r\n| documentRecordId | WorkOrderStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderStatusDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderStatusDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderStatusDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkOrderStatusDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkOrderStatusDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkOrderStatusDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkOrderStatusDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkOrderStatusDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkOrderStatusDocument->Notes | string | |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderStatusDocument", "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 Work Order Status 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 Work Order Status Document collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderStatusDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrderStatuses/Documents/Batch": { "post": { "tags": [ "Work Order Status Document" ], "summary": "Create a new collection of Work Order Status 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| workOrderStatusId | WorkOrderStatusDocument->WorkOrderStatus_Id | integer | int64 |\r\n| documentRecordId | WorkOrderStatusDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderStatusDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusDocument->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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | 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": "BatchCreateWorkOrderStatusDocument", "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/BatchCreateWorkOrderStatusDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status Document" ], "summary": "Update a collection of existing Work Order Status 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 | WorkOrderStatusDocument->Id | integer | int64 |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderStatusDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderStatusDocument->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": "BatchUpdateWorkOrderStatusDocument", "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/BatchUpdateWorkOrderStatusDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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": [ "Work Order Status Document" ], "summary": "Delete a collection of existing Work Order Status 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 | WorkOrderStatusDocument->Id | integer | int64 |\r\n| version | WorkOrderStatusDocument->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": "BatchDeleteWorkOrderStatusDocument", "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/BatchDeleteWorkOrderStatusDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Status 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/WM/WorkOrderStatuss/Documents/{id}/Active": { "patch": { "tags": [ "Work Order Status Document" ], "summary": "Change the IsActive status for an existing Work Order Status 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 | WorkOrderStatusDocument->Version | integer | int32 |\r\n| isActive | WorkOrderStatusDocument->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": "ChangeWorkOrderStatusDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrderStatuss/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Status Document" ], "summary": "Change the PermissionTree for an existing Work Order Status 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 | WorkOrderStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusDocument->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": "ChangeWorkOrderStatusDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Status Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuss/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Status Document" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Status 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 | WorkOrderStatusDocument->Id | integer | int64 |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderStatusDocument->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": "BatchChangeWorkOrderStatusDocumentPermissionTree", "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/BatchChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrderStatuss/Documents/Batch/Active": { "patch": { "tags": [ "Work Order Status Document" ], "summary": "Change the IsActive status for a collection of existing Work Order Status 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 | WorkOrderStatusDocument->Id | integer | int64 |\r\n| version | WorkOrderStatusDocument->Version | integer | int32 |\r\n| isActive | WorkOrderStatusDocument->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": "BatchChangeWorkOrderStatusDocumentIsActive", "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/BatchChangeWorkOrderStatusDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/{id}": { "get": { "tags": [ "Work Order Task" ], "summary": "Get a Work Order Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | WorkOrderTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTask->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTask->ModifiedOn | string | date-time |\r\n| version | WorkOrderTask->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTask->PermissionTree_Description | string | |\r\n| id | WorkOrderTask->Id | integer | int64 |\r\n| actualInterval1 | WorkOrderTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | WorkOrderTask->ActualInterval2 | number | decimal |\r\n| appliedInterval | WorkOrderTask->AppliedInterval | string (Allowed values: [Calendar, Usage]) | enum |\r\n| assetTaskAssetId | WorkOrderTask->AssetTaskAsset_Id | integer | int64 |\r\n| assetTaskAssetCode | WorkOrderTask->AssetTaskAsset_Code | string | |\r\n| assetTaskAssetDescription | WorkOrderTask->AssetTaskAsset_Description | string | |\r\n| assetTaskClassification1Id | WorkOrderTask->AssetTaskClassification1_Id | integer | int64 |\r\n| assetTaskClassification1Code | WorkOrderTask->AssetTaskClassification1_Code | string | |\r\n| assetTaskClassification1Description | WorkOrderTask->AssetTaskClassification1_Description | string | |\r\n| assetTaskClassification2Id | WorkOrderTask->AssetTaskClassification2_Id | integer | int64 |\r\n| assetTaskClassification2Code | WorkOrderTask->AssetTaskClassification2_Code | string | |\r\n| assetTaskClassification2Description | WorkOrderTask->AssetTaskClassification2_Description | string | |\r\n| assetTaskClassification3Id | WorkOrderTask->AssetTaskClassification3_Id | integer | int64 |\r\n| assetTaskClassification3Code | WorkOrderTask->AssetTaskClassification3_Code | string | |\r\n| assetTaskClassification3Description | WorkOrderTask->AssetTaskClassification3_Description | string | |\r\n| assetTaskClassification4Id | WorkOrderTask->AssetTaskClassification4_Id | integer | int64 |\r\n| assetTaskClassification4Code | WorkOrderTask->AssetTaskClassification4_Code | string | |\r\n| assetTaskClassification4Description | WorkOrderTask->AssetTaskClassification4_Description | string | |\r\n| assetTaskClassification5Id | WorkOrderTask->AssetTaskClassification5_Id | integer | int64 |\r\n| assetTaskClassification5Code | WorkOrderTask->AssetTaskClassification5_Code | string | |\r\n| assetTaskClassification5Description | WorkOrderTask->AssetTaskClassification5_Description | string | |\r\n| assetTaskClassification6Id | WorkOrderTask->AssetTaskClassification6_Id | integer | int64 |\r\n| assetTaskClassification6Code | WorkOrderTask->AssetTaskClassification6_Code | string | |\r\n| assetTaskClassification6Description | WorkOrderTask->AssetTaskClassification6_Description | string | |\r\n| assetTaskClassification7Id | WorkOrderTask->AssetTaskClassification7_Id | integer | int64 |\r\n| assetTaskClassification7Code | WorkOrderTask->AssetTaskClassification7_Code | string | |\r\n| assetTaskClassification7Description | WorkOrderTask->AssetTaskClassification7_Description | string | |\r\n| assetTaskClassification8Id | WorkOrderTask->AssetTaskClassification8_Id | integer | int64 |\r\n| assetTaskClassification8Code | WorkOrderTask->AssetTaskClassification8_Code | string | |\r\n| assetTaskComponentId | WorkOrderTask->AssetTaskComponent_Id | integer | int64 |\r\n| assetTaskComponentCode | WorkOrderTask->AssetTaskComponent_Code | string | |\r\n| assetTaskComponentDescription | WorkOrderTask->AssetTaskComponent_Description | string | |\r\n| assetTreePathId | WorkOrderTask->AssetTreePathId | integer | int64 |\r\n| assetTreePathItems | WorkOrderTask->AssetTreePathItems | array | array |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| componentTreePathId | WorkOrderTask->ComponentTreePathId | integer | int64 |\r\n| componentTreePathItems | WorkOrderTask->ComponentTreePathItems | array | array |\r\n| defaultInterval1Id | WorkOrderTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | WorkOrderTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | WorkOrderTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | WorkOrderTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | WorkOrderTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | WorkOrderTask->DefaultInterval2_Description | string | |\r\n| disabledReasons | WorkOrderTask->DisabledReasons | array | enum |\r\n| displaySequenceNumber | WorkOrderTask->DisplaySequenceNumber | integer | int32 |\r\n| dueDate | WorkOrderTask->DueDate | string | date |\r\n| dueReading | WorkOrderTask->DueReading | number | decimal |\r\n| failedReason | WorkOrderTask->FailedReason | string | |\r\n| failedReasonRequired | WorkOrderTask->FailedReasonRequired | boolean | |\r\n| fmecaFailedReasonId | WorkOrderTask->FmecaFailedReason_Id | integer | int64 |\r\n| fmecaFailedReasonAssetId | WorkOrderTask->FmecaFailedReason_Asset_Id | integer | int64 |\r\n| fmecaFailedReasonAssetCode | WorkOrderTask->FmecaFailedReason_Asset_Code | string | |\r\n| fmecaFailedReasonAssetDescription | WorkOrderTask->FmecaFailedReason_Asset_Description | string | |\r\n| hasNonUsageBasedMeter | WorkOrderTask->HasNonUsageBasedMeter | boolean | |\r\n| inspectionType | WorkOrderTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | WorkOrderTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | WorkOrderTask->IntervalType1_Code | string | |\r\n| intervalType1Description | WorkOrderTask->IntervalType1_Description | string | |\r\n| intervalType2Id | WorkOrderTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | WorkOrderTask->IntervalType2_Code | string | |\r\n| intervalType2Description | WorkOrderTask->IntervalType2_Description | string | |\r\n| isEnabled | WorkOrderTask->IsEnabled | boolean | |\r\n| isInspection | WorkOrderTask->IsInspection | boolean | |\r\n| isMandatory | WorkOrderTask->IsMandatory | boolean | |\r\n| lastScheduledServiceDate | WorkOrderTask->LastScheduledServiceDate | string | date |\r\n| lastScheduledServiceMeterReading | WorkOrderTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastServiceDate | WorkOrderTask->LastServiceDate | string | date |\r\n| lastServiceMeterReading | WorkOrderTask->LastServiceMeterReading | number | decimal |\r\n| meterId | WorkOrderTask->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderTask->Meter_Code | string | |\r\n| meterDescription | WorkOrderTask->Meter_Description | string | |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| motionType | WorkOrderTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| notCompletedReasonCode | WorkOrderTask->NotCompletedReason_Code | string | |\r\n| notCompletedReasonDescription | WorkOrderTask->NotCompletedReason_Description | string | |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| predefinedFailedReasonId | WorkOrderTask->PredefinedFailedReason_Id | integer | int64 |\r\n| predefinedFailedReasonCode | WorkOrderTask->PredefinedFailedReason_Code | string | |\r\n| predefinedFailedReasonDescription | WorkOrderTask->PredefinedFailedReason_Description | string | |\r\n| priority | WorkOrderTask->Priority | number | decimal |\r\n| schedulingMethod | WorkOrderTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sectionId | WorkOrderTask->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrderTask->Section_Code | string | |\r\n| sectionDescription | WorkOrderTask->Section_Description | string | |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| staffMemberId | WorkOrderTask->StaffMember_Id | integer | int64 |\r\n| staffMemberCode | WorkOrderTask->StaffMember_Code | string | |\r\n| staffMemberResourceType | WorkOrderTask->StaffMember_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskAlternativeDescription | WorkOrderTask->TaskAlternativeDescription | string | |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification1Code | WorkOrderTask->TaskFeedbackClassification1_Code | string | |\r\n| taskFeedbackClassification1Description | WorkOrderTask->TaskFeedbackClassification1_Description | string | |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification2Code | WorkOrderTask->TaskFeedbackClassification2_Code | string | |\r\n| taskFeedbackClassification2Description | WorkOrderTask->TaskFeedbackClassification2_Description | string | |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification3Code | WorkOrderTask->TaskFeedbackClassification3_Code | string | |\r\n| taskFeedbackClassification3Description | WorkOrderTask->TaskFeedbackClassification3_Description | string | |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification4Code | WorkOrderTask->TaskFeedbackClassification4_Code | string | |\r\n| taskFeedbackClassification4Description | WorkOrderTask->TaskFeedbackClassification4_Description | string | |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_Id | integer | int64 |\r\n| taskFeedbackClassification5Code | WorkOrderTask->TaskFeedbackClassification5_Code | string | |\r\n| taskFeedbackClassification5Description | WorkOrderTask->TaskFeedbackClassification5_Description | string | |\r\n| taskId | WorkOrderTask->TaskId | integer | int64 |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| totalDowntime | WorkOrderTask->TotalDowntime | string | duration |\r\n| totalDuration | WorkOrderTask->TotalDuration | string | duration |\r\n| tradeId | WorkOrderTask->Trade_Id | integer | int64 |\r\n| tradeCode | WorkOrderTask->Trade_Code | string | |\r\n| tradeDescription | WorkOrderTask->Trade_Description | string | |\r\n| triggerWhenLowerCriticalBoundExceeded | WorkOrderTask->TriggerWhenLowerCriticalBoundExceeded | boolean | |\r\n| triggerWhenLowerWarningBoundExceeded | WorkOrderTask->TriggerWhenLowerWarningBoundExceeded | boolean | |\r\n| triggerWhenUpperCriticalBoundExceeded | WorkOrderTask->TriggerWhenUpperCriticalBoundExceeded | boolean | |\r\n| triggerWhenUpperWarningBoundExceeded | WorkOrderTask->TriggerWhenUpperWarningBoundExceeded | boolean | |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| workOrderRequiredBy | WorkOrderTask->WorkOrder_RequiredBy | string | date-time |\r\n| workOrderStatusId | WorkOrderTask->WorkOrder_Status_Id | integer | int64 |\r\n| workOrderStatusBaseStatus | WorkOrderTask->WorkOrder_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderInspectionTaskId | WorkOrderTask->WorkOrderInspectionTask_Id | integer | int64 |\r\n| workOrderInspectionTaskTaskCode | WorkOrderTask->WorkOrderInspectionTask_TaskCode | string | |\r\n| workOrderInspectionTaskTaskDescription | WorkOrderTask->WorkOrderInspectionTask_TaskDescription | string | |\r\n| workOrderInspectionTaskWorkOrderId | WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Id | integer | int64 |\r\n| workOrderInspectionTaskWorkOrderCode | WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Code | string | |\r\n| workOrderInspectionTaskWorkOrderDescription | WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task" ], "summary": "Update an existing Work Order Task 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 | WorkOrderTask->Version | integer | int32 |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| staffMemberId | WorkOrderTask->StaffMember_Id | integer | int64 |\r\n| sectionId | WorkOrderTask->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTask->Trade_Id | integer | int64 |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| predefinedFailedReasonId | WorkOrderTask->PredefinedFailedReason_Id | integer | int64 |\r\n| fmecaFailedReasonId | WorkOrderTask->FmecaFailedReason_Id | integer | int64 |\r\n| failedReason | WorkOrderTask->FailedReason | string | |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_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| completed | Nullable | False | |\r\n| meterReadingValue | Nullable | True | WorkOrderTask->Meter_Id eq NULL |\r\n| notCompletedReasonId | Nullable | True | WorkOrderTask->Completed eq true |\r\n| passed | Nullable | False | WorkOrderTask->IsInspection eq TRUE |\r\n| passed | Nullable | True | WorkOrderTask->IsInspection eq false OR WorkOrderTask->Completed eq false |\r\n| passed | Read-only | True | WorkOrderTask->InspectionType eq 'ManualMonitoring' AND WorkOrderTask->Completed eq true |\r\n\r\n", "operationId": "UpdateWorkOrderTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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": [ "Work Order Task" ], "summary": "Delete an existing Work Order Task 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 | WorkOrderTask->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": "DeleteWorkOrderTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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/WM/WorkOrders/Tasks/{workOrderTaskSpareWorkOrderTaskId}/RequisitionItems": { "get": { "tags": [ "Work Order Task" ], "summary": "Get a collection of Work Order Task resources for the Requisition.", "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 | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| workOrderTaskSpareCode | RequisitionItem->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | RequisitionItem->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareStockItemMaterialMasterId | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| workOrderTaskSpareStockItemWarehouseCode | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description | string | |\r\n| workOrderTaskSpareStockItemAverageItemCost | RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost | number | decimal |\r\n| workOrderTaskSpareStockItemQuantityOnHand | RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand | number | decimal |\r\n| workOrderTaskSpareSupplierCode | RequisitionItem->WorkOrderTaskSpare_Supplier_Code | string | |\r\n| workOrderTaskSpareSupplierDescription | RequisitionItem->WorkOrderTaskSpare_Supplier_Description | string | |\r\n| workOrderTaskSpareUnitPriceInSpareCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareUnitPriceInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskSpareTotalUsedInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency | number | decimal |\r\n| quantityIssued | RequisitionItem->QuantityIssued | number | decimal |\r\n| quantityNotIssued | RequisitionItem->QuantityNotIssued | number | decimal |\r\n", "operationId": "GetRequisitionItemForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskSpareWorkOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task collection", "schema": { "$ref": "#/definitions/GetRequisitionItemForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks": { "get": { "tags": [ "Work Order Task" ], "summary": "Get a collection of Work Order Task resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTask->Id | integer | int64 |\r\n| version | WorkOrderTask->Version | integer | int32 |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| workOrderStatusId | WorkOrderTask->WorkOrder_Status_Id | integer | int64 |\r\n| workOrderStatusCode | WorkOrderTask->WorkOrder_Status_Code | string | |\r\n| workOrderStatusDescription | WorkOrderTask->WorkOrder_Status_Description | string | |\r\n| assetTaskAssetId | WorkOrderTask->AssetTaskAsset_Id | integer | int64 |\r\n| assetTaskAssetCode | WorkOrderTask->AssetTaskAsset_Code | string | |\r\n| assetTaskAssetDescription | WorkOrderTask->AssetTaskAsset_Description | string | |\r\n| assetTaskComponentId | WorkOrderTask->AssetTaskComponent_Id | integer | int64 |\r\n| assetTaskComponentCode | WorkOrderTask->AssetTaskComponent_Code | string | |\r\n| assetTaskComponentDescription | WorkOrderTask->AssetTaskComponent_Description | string | |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| taskId | WorkOrderTask->TaskId | integer | int64 |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskAlternativeDescription | WorkOrderTask->TaskAlternativeDescription | string | |\r\n| hasNonUsageBasedMeter | WorkOrderTask->HasNonUsageBasedMeter | boolean | |\r\n| dueDate | WorkOrderTask->DueDate | string | date |\r\n| dueReading | WorkOrderTask->DueReading | number | decimal |\r\n| intervalType1Id | WorkOrderTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | WorkOrderTask->IntervalType1_Code | string | |\r\n| intervalType1Description | WorkOrderTask->IntervalType1_Description | string | |\r\n| intervalType2Id | WorkOrderTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | WorkOrderTask->IntervalType2_Code | string | |\r\n| intervalType2Description | WorkOrderTask->IntervalType2_Description | string | |\r\n| defaultInterval1Id | WorkOrderTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | WorkOrderTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | WorkOrderTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | WorkOrderTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | WorkOrderTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | WorkOrderTask->DefaultInterval2_Description | string | |\r\n| actualInterval1 | WorkOrderTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | WorkOrderTask->ActualInterval2 | number | decimal |\r\n| appliedInterval | WorkOrderTask->AppliedInterval | string (Allowed values: [Calendar, Usage]) | enum |\r\n| isMandatory | WorkOrderTask->IsMandatory | boolean | |\r\n| isInspection | WorkOrderTask->IsInspection | boolean | |\r\n| isEnabled | WorkOrderTask->IsEnabled | boolean | |\r\n| meterId | WorkOrderTask->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderTask->Meter_Code | string | |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification1Code | WorkOrderTask->TaskFeedbackClassification1_Code | string | |\r\n| taskFeedbackClassification1Description | WorkOrderTask->TaskFeedbackClassification1_Description | string | |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification2Code | WorkOrderTask->TaskFeedbackClassification2_Code | string | |\r\n| taskFeedbackClassification2Description | WorkOrderTask->TaskFeedbackClassification2_Description | string | |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification3Code | WorkOrderTask->TaskFeedbackClassification3_Code | string | |\r\n| taskFeedbackClassification3Description | WorkOrderTask->TaskFeedbackClassification3_Description | string | |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification4Code | WorkOrderTask->TaskFeedbackClassification4_Code | string | |\r\n| taskFeedbackClassification4Description | WorkOrderTask->TaskFeedbackClassification4_Description | string | |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_Id | integer | int64 |\r\n| taskFeedbackClassification5Code | WorkOrderTask->TaskFeedbackClassification5_Code | string | |\r\n| taskFeedbackClassification5Description | WorkOrderTask->TaskFeedbackClassification5_Description | string | |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| notCompletedReasonCode | WorkOrderTask->NotCompletedReason_Code | string | |\r\n| notCompletedReasonDescription | WorkOrderTask->NotCompletedReason_Description | string | |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| modifiedOn | WorkOrderTask->ModifiedOn | string | date-time |\r\n| createdOn | WorkOrderTask->CreatedOn | string | date-time |\r\n| assetTreePathItems | WorkOrderTask->AssetTreePathItems | array | array |\r\n| componentTreePathItems | WorkOrderTask->ComponentTreePathItems | array | array |\r\n| workOrderInspectionTaskId | WorkOrderTask->WorkOrderInspectionTask_Id | integer | int64 |\r\n", "operationId": "GetWorkOrderTaskCollection", "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 Work Order Task collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Task" ], "summary": "Create a new Work Order Task 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| taskId | WorkOrderTask->TaskId | integer | int64 |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| staffMemberId | WorkOrderTask->StaffMember_Id | integer | int64 |\r\n| sectionId | WorkOrderTask->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTask->Trade_Id | integer | int64 |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| predefinedFailedReasonId | WorkOrderTask->PredefinedFailedReason_Id | integer | int64 |\r\n| fmecaFailedReasonId | WorkOrderTask->FmecaFailedReason_Id | integer | int64 |\r\n| failedReason | WorkOrderTask->FailedReason | string | |\r\n| permissionTreeId | WorkOrderTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_Id | integer | int64 |\r\n| workOrderId | WorkOrderTask->WorkOrder_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| taskId | Required | True | |\r\n| taskId | Nullable | False | |\r\n| taskId | Min Value | >= 0| |\r\n| taskType | Required | True | |\r\n| taskType | Nullable | False | |\r\n| completed | Nullable | False | |\r\n| meterReadingValue | Nullable | True | WorkOrderTask->Meter_Id eq NULL |\r\n| notCompletedReasonId | Nullable | True | WorkOrderTask->Completed eq true |\r\n| passed | Nullable | False | WorkOrderTask->IsInspection eq TRUE |\r\n| passed | Nullable | True | WorkOrderTask->IsInspection eq false OR WorkOrderTask->Completed eq false |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTask", "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/CreateWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/{workOrderId}/Tasks": { "get": { "tags": [ "Work Order Task" ], "summary": "Get a collection of Work Order Task resources for the Work Order.", "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 | WorkOrderTask->Id | integer | int64 |\r\n| version | WorkOrderTask->Version | integer | int32 |\r\n| taskId | WorkOrderTask->TaskId | integer | int64 |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| assetTaskAssetId | WorkOrderTask->AssetTaskAsset_Id | integer | int64 |\r\n| assetTaskAssetCode | WorkOrderTask->AssetTaskAsset_Code | string | |\r\n| assetTaskAssetDescription | WorkOrderTask->AssetTaskAsset_Description | string | |\r\n| taskAlternativeDescription | WorkOrderTask->TaskAlternativeDescription | string | |\r\n| assetTaskComponentId | WorkOrderTask->AssetTaskComponent_Id | integer | int64 |\r\n| assetTaskComponentCode | WorkOrderTask->AssetTaskComponent_Code | string | |\r\n| assetTaskComponentDescription | WorkOrderTask->AssetTaskComponent_Description | string | |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| meterId | WorkOrderTask->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderTask->Meter_Code | string | |\r\n| meterDescription | WorkOrderTask->Meter_Description | string | |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| isMandatory | WorkOrderTask->IsMandatory | boolean | |\r\n| isInspection | WorkOrderTask->IsInspection | boolean | |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| notCompletedReasonCode | WorkOrderTask->NotCompletedReason_Code | string | |\r\n| notCompletedReasonDescription | WorkOrderTask->NotCompletedReason_Description | string | |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| isEnabled | WorkOrderTask->IsEnabled | boolean | |\r\n| assetTreePathItems | WorkOrderTask->AssetTreePathItems | array | array |\r\n| componentTreePathItems | WorkOrderTask->ComponentTreePathItems | array | array |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| displaySequenceNumber | WorkOrderTask->DisplaySequenceNumber | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Task collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/{id}/FollowUpTask/Spares": { "get": { "tags": [ "Work Order Task" ], "summary": "Get a collection of Regular Asset Task Spare resources for the Regular Asset Task Follow Up Task associated with the Work Order Task.", "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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTaskSpare->MaterialMaster_Description | string | |\r\n| regularAssetTaskCode | RegularAssetTaskSpare->RegularAssetTask_Code | string | |\r\n| regularAssetTaskAssetTreePathItems | RegularAssetTaskSpare->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentTreePathItems | RegularAssetTaskSpare->RegularAssetTask_Component_TreePathItems | array | array |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetWorkOrderTaskFollowUpTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskFollowUpTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskAssetTaskForAsset": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup up the Regular Asset Task for the Work Order Task", "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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetSiteCode | RegularAssetTask->Asset_Site_Code | string | |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTask->DefaultInterval2_Description | string | |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| actualInterval1 | RegularAssetTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | RegularAssetTask->ActualInterval2 | number | decimal |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetTask->Meter_Code | string | |\r\n| meterDescription | RegularAssetTask->Meter_Description | string | |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | RegularAssetTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | RegularAssetTask->ResponsibleSection_Description | string | |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | RegularAssetTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | RegularAssetTask->ResponsibleTrade_Description | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | RegularAssetTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceDescription | RegularAssetTask->ResponsibleStaffMemberResource_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskAssetTaskForAsset", "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 Regular Asset Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAssetTaskForAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskAssetTaskForSite": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup up the Regular Asset Task for the Site of the Work Order Task", "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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetSiteCode | RegularAssetTask->Asset_Site_Code | string | |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTask->DefaultInterval2_Description | string | |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| actualInterval1 | RegularAssetTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | RegularAssetTask->ActualInterval2 | number | decimal |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetTask->Meter_Code | string | |\r\n| meterDescription | RegularAssetTask->Meter_Description | string | |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n", "operationId": "LookupWorkOrderTaskAssetTaskForSite", "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 Regular Asset Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAssetTaskForSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskChangePermissionTree": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the permission set for changing the Work Order Task.", "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": "LookupWorkOrderTaskChangePermissionTree", "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/WorkOrderTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskFinancialYearPeriod": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Financial Year Period for the Work Order Task.", "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 | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskFinancialYearPeriod", "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 Financial Year Period collection", "schema": { "$ref": "#/definitions/WorkOrderTaskFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskFmecaFailedReason": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Preconfigured Reason for the Work Order Task.", "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 | AssetFmeca->Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetDescription | AssetFmeca->Asset_Description | string | |\r\n| componentCode | AssetFmeca->Component_Code | string | |\r\n| componentDescription | AssetFmeca->Component_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskFmecaFailedReason", "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 Asset FMECA collection", "schema": { "$ref": "#/definitions/WorkOrderTaskFmecaFailedReasonLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskInsertPermissionTree": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the permission set for creating the Work Order Task.", "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": "LookupWorkOrderTaskInsertPermissionTree", "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/WorkOrderTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskNotCompletedReason": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Preconfigured Reason for the Work Order Task.", "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 | PreconfiguredReason->Id | integer | int64 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskNotCompletedReason", "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 Preconfigured Reason collection", "schema": { "$ref": "#/definitions/WorkOrderTaskNotCompletedReasonLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskPredefinedFailedReason": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Preconfigured Reason for the Work Order Task.", "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 | PreconfiguredReason->Id | integer | int64 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskPredefinedFailedReason", "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 Preconfigured Reason collection", "schema": { "$ref": "#/definitions/WorkOrderTaskPredefinedFailedReasonLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskResourceContact": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Resource for the Work Order Task.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceContact", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkOrderTaskRequesterContactLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskSection": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Section for the Work Order Task.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskSection", "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 Section collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskStaffMember": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup up the Staff Member for the Work Order Task", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupWorkOrderTaskStaffMember", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkOrderTaskStaffMemberLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskStandardTask": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup up the Standard Task for the Work Order Task", "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 | StandardTask->Id | integer | int64 |\r\n| code | StandardTask->Code | string | |\r\n| description | StandardTask->Description | string | |\r\n| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | StandardTask->IntervalType1_Code | string | |\r\n| intervalType1Description | StandardTask->IntervalType1_Description | string | |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | StandardTask->IntervalType2_Code | string | |\r\n| intervalType2Description | StandardTask->IntervalType2_Description | string | |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | StandardTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | StandardTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | StandardTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | StandardTask->DefaultInterval2_Description | string | |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | StandardTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | StandardTask->ResponsibleSection_Description | string | |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | StandardTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | StandardTask->ResponsibleTrade_Description | string | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | StandardTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceDescription | StandardTask->ResponsibleStaffMemberResource_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskStandardTask", "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 Standard Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskTaskFeedbackClassification1": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup Work Order Task Feedback Classification 1 for the Work Order Task", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskTaskFeedbackClassification1", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskTaskFeedbackClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskTaskFeedbackClassification2": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup Work Order Task Feedback Classification 2 for the Work Order Task", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskTaskFeedbackClassification2", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskTaskFeedbackClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskTaskFeedbackClassification3": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup Work Order Task Feedback Classification 3 for the Work Order Task", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskTaskFeedbackClassification3", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskTaskFeedbackClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskTaskFeedbackClassification4": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup Work Order Task Feedback Classification 4 for the Work Order Task", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskTaskFeedbackClassification4", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskTaskFeedbackClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskTaskFeedbackClassification5": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup Work Order Task Feedback Classification 5 for the Work Order Task", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskTaskFeedbackClassification5", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/WorkOrderTaskTaskFeedbackClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskTrade": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup the Trade for the Work Order Task.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskTrade", "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 Trade collection", "schema": { "$ref": "#/definitions/WorkOrderTaskTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskWorkOrder": { "get": { "tags": [ "Work Order Task" ], "summary": "Lookup up the Work Order for the Work Order Task", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "LookupWorkOrderTaskWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkOrderTaskWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Batch/{ids}": { "get": { "tags": [ "Work Order Task" ], "summary": "Get a collection of Work Order Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | WorkOrderTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTask->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTask->ModifiedOn | string | date-time |\r\n| version | WorkOrderTask->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTask->PermissionTree_Description | string | |\r\n| id | WorkOrderTask->Id | integer | int64 |\r\n| actualInterval1 | WorkOrderTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | WorkOrderTask->ActualInterval2 | number | decimal |\r\n| appliedInterval | WorkOrderTask->AppliedInterval | string (Allowed values: [Calendar, Usage]) | enum |\r\n| assetTaskAssetId | WorkOrderTask->AssetTaskAsset_Id | integer | int64 |\r\n| assetTaskAssetCode | WorkOrderTask->AssetTaskAsset_Code | string | |\r\n| assetTaskAssetDescription | WorkOrderTask->AssetTaskAsset_Description | string | |\r\n| assetTaskClassification1Id | WorkOrderTask->AssetTaskClassification1_Id | integer | int64 |\r\n| assetTaskClassification1Code | WorkOrderTask->AssetTaskClassification1_Code | string | |\r\n| assetTaskClassification1Description | WorkOrderTask->AssetTaskClassification1_Description | string | |\r\n| assetTaskClassification2Id | WorkOrderTask->AssetTaskClassification2_Id | integer | int64 |\r\n| assetTaskClassification2Code | WorkOrderTask->AssetTaskClassification2_Code | string | |\r\n| assetTaskClassification2Description | WorkOrderTask->AssetTaskClassification2_Description | string | |\r\n| assetTaskClassification3Id | WorkOrderTask->AssetTaskClassification3_Id | integer | int64 |\r\n| assetTaskClassification3Code | WorkOrderTask->AssetTaskClassification3_Code | string | |\r\n| assetTaskClassification3Description | WorkOrderTask->AssetTaskClassification3_Description | string | |\r\n| assetTaskClassification4Id | WorkOrderTask->AssetTaskClassification4_Id | integer | int64 |\r\n| assetTaskClassification4Code | WorkOrderTask->AssetTaskClassification4_Code | string | |\r\n| assetTaskClassification4Description | WorkOrderTask->AssetTaskClassification4_Description | string | |\r\n| assetTaskClassification5Id | WorkOrderTask->AssetTaskClassification5_Id | integer | int64 |\r\n| assetTaskClassification5Code | WorkOrderTask->AssetTaskClassification5_Code | string | |\r\n| assetTaskClassification5Description | WorkOrderTask->AssetTaskClassification5_Description | string | |\r\n| assetTaskClassification6Id | WorkOrderTask->AssetTaskClassification6_Id | integer | int64 |\r\n| assetTaskClassification6Code | WorkOrderTask->AssetTaskClassification6_Code | string | |\r\n| assetTaskClassification6Description | WorkOrderTask->AssetTaskClassification6_Description | string | |\r\n| assetTaskClassification7Id | WorkOrderTask->AssetTaskClassification7_Id | integer | int64 |\r\n| assetTaskClassification7Code | WorkOrderTask->AssetTaskClassification7_Code | string | |\r\n| assetTaskClassification7Description | WorkOrderTask->AssetTaskClassification7_Description | string | |\r\n| assetTaskClassification8Id | WorkOrderTask->AssetTaskClassification8_Id | integer | int64 |\r\n| assetTaskClassification8Code | WorkOrderTask->AssetTaskClassification8_Code | string | |\r\n| assetTaskComponentId | WorkOrderTask->AssetTaskComponent_Id | integer | int64 |\r\n| assetTaskComponentCode | WorkOrderTask->AssetTaskComponent_Code | string | |\r\n| assetTaskComponentDescription | WorkOrderTask->AssetTaskComponent_Description | string | |\r\n| assetTreePathId | WorkOrderTask->AssetTreePathId | integer | int64 |\r\n| assetTreePathItems | WorkOrderTask->AssetTreePathItems | array | array |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| componentTreePathId | WorkOrderTask->ComponentTreePathId | integer | int64 |\r\n| componentTreePathItems | WorkOrderTask->ComponentTreePathItems | array | array |\r\n| defaultInterval1Id | WorkOrderTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | WorkOrderTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | WorkOrderTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | WorkOrderTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | WorkOrderTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | WorkOrderTask->DefaultInterval2_Description | string | |\r\n| disabledReasons | WorkOrderTask->DisabledReasons | array | enum |\r\n| displaySequenceNumber | WorkOrderTask->DisplaySequenceNumber | integer | int32 |\r\n| dueDate | WorkOrderTask->DueDate | string | date |\r\n| dueReading | WorkOrderTask->DueReading | number | decimal |\r\n| failedReason | WorkOrderTask->FailedReason | string | |\r\n| failedReasonRequired | WorkOrderTask->FailedReasonRequired | boolean | |\r\n| fmecaFailedReasonId | WorkOrderTask->FmecaFailedReason_Id | integer | int64 |\r\n| fmecaFailedReasonAssetId | WorkOrderTask->FmecaFailedReason_Asset_Id | integer | int64 |\r\n| fmecaFailedReasonAssetCode | WorkOrderTask->FmecaFailedReason_Asset_Code | string | |\r\n| fmecaFailedReasonAssetDescription | WorkOrderTask->FmecaFailedReason_Asset_Description | string | |\r\n| hasNonUsageBasedMeter | WorkOrderTask->HasNonUsageBasedMeter | boolean | |\r\n| inspectionType | WorkOrderTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | WorkOrderTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | WorkOrderTask->IntervalType1_Code | string | |\r\n| intervalType1Description | WorkOrderTask->IntervalType1_Description | string | |\r\n| intervalType2Id | WorkOrderTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | WorkOrderTask->IntervalType2_Code | string | |\r\n| intervalType2Description | WorkOrderTask->IntervalType2_Description | string | |\r\n| isEnabled | WorkOrderTask->IsEnabled | boolean | |\r\n| isInspection | WorkOrderTask->IsInspection | boolean | |\r\n| isMandatory | WorkOrderTask->IsMandatory | boolean | |\r\n| lastScheduledServiceDate | WorkOrderTask->LastScheduledServiceDate | string | date |\r\n| lastScheduledServiceMeterReading | WorkOrderTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastServiceDate | WorkOrderTask->LastServiceDate | string | date |\r\n| lastServiceMeterReading | WorkOrderTask->LastServiceMeterReading | number | decimal |\r\n| meterId | WorkOrderTask->Meter_Id | integer | int64 |\r\n| meterCode | WorkOrderTask->Meter_Code | string | |\r\n| meterDescription | WorkOrderTask->Meter_Description | string | |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| motionType | WorkOrderTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| notCompletedReasonCode | WorkOrderTask->NotCompletedReason_Code | string | |\r\n| notCompletedReasonDescription | WorkOrderTask->NotCompletedReason_Description | string | |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| predefinedFailedReasonId | WorkOrderTask->PredefinedFailedReason_Id | integer | int64 |\r\n| predefinedFailedReasonCode | WorkOrderTask->PredefinedFailedReason_Code | string | |\r\n| predefinedFailedReasonDescription | WorkOrderTask->PredefinedFailedReason_Description | string | |\r\n| priority | WorkOrderTask->Priority | number | decimal |\r\n| schedulingMethod | WorkOrderTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sectionId | WorkOrderTask->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrderTask->Section_Code | string | |\r\n| sectionDescription | WorkOrderTask->Section_Description | string | |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| staffMemberId | WorkOrderTask->StaffMember_Id | integer | int64 |\r\n| staffMemberCode | WorkOrderTask->StaffMember_Code | string | |\r\n| staffMemberResourceType | WorkOrderTask->StaffMember_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskAlternativeDescription | WorkOrderTask->TaskAlternativeDescription | string | |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification1Code | WorkOrderTask->TaskFeedbackClassification1_Code | string | |\r\n| taskFeedbackClassification1Description | WorkOrderTask->TaskFeedbackClassification1_Description | string | |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification2Code | WorkOrderTask->TaskFeedbackClassification2_Code | string | |\r\n| taskFeedbackClassification2Description | WorkOrderTask->TaskFeedbackClassification2_Description | string | |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification3Code | WorkOrderTask->TaskFeedbackClassification3_Code | string | |\r\n| taskFeedbackClassification3Description | WorkOrderTask->TaskFeedbackClassification3_Description | string | |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification4Code | WorkOrderTask->TaskFeedbackClassification4_Code | string | |\r\n| taskFeedbackClassification4Description | WorkOrderTask->TaskFeedbackClassification4_Description | string | |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_Id | integer | int64 |\r\n| taskFeedbackClassification5Code | WorkOrderTask->TaskFeedbackClassification5_Code | string | |\r\n| taskFeedbackClassification5Description | WorkOrderTask->TaskFeedbackClassification5_Description | string | |\r\n| taskId | WorkOrderTask->TaskId | integer | int64 |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| totalDowntime | WorkOrderTask->TotalDowntime | string | duration |\r\n| totalDuration | WorkOrderTask->TotalDuration | string | duration |\r\n| tradeId | WorkOrderTask->Trade_Id | integer | int64 |\r\n| tradeCode | WorkOrderTask->Trade_Code | string | |\r\n| tradeDescription | WorkOrderTask->Trade_Description | string | |\r\n| triggerWhenLowerCriticalBoundExceeded | WorkOrderTask->TriggerWhenLowerCriticalBoundExceeded | boolean | |\r\n| triggerWhenLowerWarningBoundExceeded | WorkOrderTask->TriggerWhenLowerWarningBoundExceeded | boolean | |\r\n| triggerWhenUpperCriticalBoundExceeded | WorkOrderTask->TriggerWhenUpperCriticalBoundExceeded | boolean | |\r\n| triggerWhenUpperWarningBoundExceeded | WorkOrderTask->TriggerWhenUpperWarningBoundExceeded | boolean | |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| workOrderRequiredBy | WorkOrderTask->WorkOrder_RequiredBy | string | date-time |\r\n| workOrderStatusId | WorkOrderTask->WorkOrder_Status_Id | integer | int64 |\r\n| workOrderStatusBaseStatus | WorkOrderTask->WorkOrder_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderInspectionTaskId | WorkOrderTask->WorkOrderInspectionTask_Id | integer | int64 |\r\n| workOrderInspectionTaskTaskCode | WorkOrderTask->WorkOrderInspectionTask_TaskCode | string | |\r\n| workOrderInspectionTaskTaskDescription | WorkOrderTask->WorkOrderInspectionTask_TaskDescription | string | |\r\n| workOrderInspectionTaskWorkOrderId | WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Id | integer | int64 |\r\n| workOrderInspectionTaskWorkOrderCode | WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Code | string | |\r\n| workOrderInspectionTaskWorkOrderDescription | WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderTask", "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 Work Order Task 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 Work Order Task collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Batch": { "post": { "tags": [ "Work Order Task" ], "summary": "Create a new collection of Work Order Task 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| taskId | WorkOrderTask->TaskId | integer | int64 |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| staffMemberId | WorkOrderTask->StaffMember_Id | integer | int64 |\r\n| sectionId | WorkOrderTask->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTask->Trade_Id | integer | int64 |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| predefinedFailedReasonId | WorkOrderTask->PredefinedFailedReason_Id | integer | int64 |\r\n| fmecaFailedReasonId | WorkOrderTask->FmecaFailedReason_Id | integer | int64 |\r\n| failedReason | WorkOrderTask->FailedReason | string | |\r\n| permissionTreeId | WorkOrderTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_Id | integer | int64 |\r\n| workOrderId | WorkOrderTask->WorkOrder_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| taskId | Required | True | |\r\n| taskId | Nullable | False | |\r\n| taskId | Min Value | >= 0| |\r\n| taskType | Required | True | |\r\n| taskType | Nullable | False | |\r\n| completed | Nullable | False | |\r\n| meterReadingValue | Nullable | True | WorkOrderTask->Meter_Id eq NULL |\r\n| notCompletedReasonId | Nullable | True | WorkOrderTask->Completed eq true |\r\n| passed | Nullable | False | WorkOrderTask->IsInspection eq TRUE |\r\n| passed | Nullable | True | WorkOrderTask->IsInspection eq false OR WorkOrderTask->Completed eq false |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderTask", "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/BatchCreateWorkOrderTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task 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": [ "Work Order Task" ], "summary": "Update a collection of existing Work Order Task 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 | WorkOrderTask->Id | integer | int64 |\r\n| version | WorkOrderTask->Version | integer | int32 |\r\n| completed | WorkOrderTask->Completed | boolean | |\r\n| completedOn | WorkOrderTask->CompletedOn | string | date-time |\r\n| meterReadingValue | WorkOrderTask->MeterReadingValue | number | decimal |\r\n| meterReadingOn | WorkOrderTask->MeterReadingOn | string | date-time |\r\n| staffMemberId | WorkOrderTask->StaffMember_Id | integer | int64 |\r\n| sectionId | WorkOrderTask->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTask->Trade_Id | integer | int64 |\r\n| notes | WorkOrderTask->Notes | string | |\r\n| notCompletedReasonId | WorkOrderTask->NotCompletedReason_Id | integer | int64 |\r\n| predefinedFailedReasonId | WorkOrderTask->PredefinedFailedReason_Id | integer | int64 |\r\n| fmecaFailedReasonId | WorkOrderTask->FmecaFailedReason_Id | integer | int64 |\r\n| failedReason | WorkOrderTask->FailedReason | string | |\r\n| passed | WorkOrderTask->Passed | boolean | |\r\n| sequenceNumber | WorkOrderTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTask->StartedOn | string | date-time |\r\n| taskFeedbackClassification1Id | WorkOrderTask->TaskFeedbackClassification1_Id | integer | int64 |\r\n| taskFeedbackClassification2Id | WorkOrderTask->TaskFeedbackClassification2_Id | integer | int64 |\r\n| taskFeedbackClassification3Id | WorkOrderTask->TaskFeedbackClassification3_Id | integer | int64 |\r\n| taskFeedbackClassification4Id | WorkOrderTask->TaskFeedbackClassification4_Id | integer | int64 |\r\n| taskFeedbackClassification5Id | WorkOrderTask->TaskFeedbackClassification5_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| completed | Nullable | False | |\r\n| meterReadingValue | Nullable | True | WorkOrderTask->Meter_Id eq NULL |\r\n| notCompletedReasonId | Nullable | True | WorkOrderTask->Completed eq true |\r\n| passed | Nullable | False | WorkOrderTask->IsInspection eq TRUE |\r\n| passed | Nullable | True | WorkOrderTask->IsInspection eq false OR WorkOrderTask->Completed eq false |\r\n| passed | Read-only | True | WorkOrderTask->InspectionType eq 'ManualMonitoring' AND WorkOrderTask->Completed eq true |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTask", "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/BatchUpdateWorkOrderTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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": [ "Work Order Task" ], "summary": "Delete a collection of existing Work Order Task 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 | WorkOrderTask->Id | integer | int64 |\r\n| version | WorkOrderTask->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": "BatchDeleteWorkOrderTask", "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/BatchDeleteWorkOrderTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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/WM/WorkOrders/Tasks/{id}/AddSpareToNewRequisition": { "post": { "tags": [ "Work Order Task" ], "summary": "Generate a Requisition for the Work Order Task 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 | AddSpareToNewRequisition->Code | string | |\r\n| permissionTreeId | AddSpareToNewRequisition->PermissionTree_Id | integer | int64 |\r\n| requesterType | AddSpareToNewRequisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | AddSpareToNewRequisition->Requester | string | |\r\n| requesterContactId | AddSpareToNewRequisition->RequesterContact_Id | integer | int64 |\r\n| requestedOn | AddSpareToNewRequisition->RequestedOn | string | date-time |\r\n| sequenceNumber | AddSpareToNewRequisition->SequenceNumber | integer | int32 |\r\n| notes | AddSpareToNewRequisition->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 | System Generated | true | If no value specified |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requestedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "AddSpareToNewRequisitionForWorkOrderTask", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/AddSpareToNewRequisitionForWorkTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/{id}/AddSpareToRequisition": { "post": { "tags": [ "Work Order Task" ], "summary": "Add the Work Order Task Spare for the Work Order Task to the specified Requisition.", "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| requisitionId | AddSpareToRequisition->Requisition_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| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n\r\n", "operationId": "AddSpareToRequisitionForWorkOrderTask", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/AddSpareToRequisitionForWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Batch/AddSpareToNewRequisition": { "post": { "tags": [ "Work Order Task" ], "summary": "Generate Requisitions for a collection of Work Order Task resources. If the items in the collection of Work Order Task are from more than one Work Order then a Requisition will be generated for each Work Order.", "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| entityIds | AddSpareToNewRequisition->EntityIds | array | array |\r\n| permissionTreeId | AddSpareToNewRequisition->PermissionTree_Id | integer | int64 |\r\n| code | AddSpareToNewRequisition->Code | string | |\r\n| requesterType | AddSpareToNewRequisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requester | AddSpareToNewRequisition->Requester | string | |\r\n| requesterContactId | AddSpareToNewRequisition->RequesterContact_Id | integer | int64 |\r\n| requestedOn | AddSpareToNewRequisition->RequestedOn | string | date-time |\r\n| sequenceNumber | AddSpareToNewRequisition->SequenceNumber | integer | int32 |\r\n| notes | AddSpareToNewRequisition->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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| code | System Generated | true | If no value specified |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requestedOn | Required | True | |\r\n| requestedOn | Nullable | False | |\r\n\r\n", "operationId": "BatchAddSpareToNewRequisitionForWorkOrderTask", "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/BatchAddSpareToNewRequisitionForWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Batch/AddToRequisition": { "post": { "tags": [ "Work Order Task" ], "summary": "Add the Work Order Task Spare for the Work Order Task to the specified Requisition.", "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| entityIds | AddSpareToRequisition->EntityIds | array | array |\r\n| requisitionId | AddSpareToRequisition->Requisition_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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n\r\n", "operationId": "BatchAddSpareToRequisitionForWorkOrderTask", "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/BatchAddSpareToRequisitionForWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Batch/IssueAll": { "post": { "tags": [ "Work Order Task" ], "summary": "Issue all Items for collection of Work Order Task 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| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchIssueAllWorkOrderTask", "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/BatchIssueAllWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Batch/ReturnAll": { "post": { "tags": [ "Work Order Task" ], "summary": "Return all Items for collection of Work Order Task 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| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchReturnAllWorkOrderTask", "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/BatchReturnAllWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task" ], "summary": "Change the PermissionTree for an existing Work Order Task 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 | WorkOrderTask->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTask->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": "ChangeWorkOrderTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/{id}/IssueAll": { "post": { "tags": [ "Work Order Task" ], "summary": "Issue all Items for Work Order Task 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| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "IssueAllWorkOrderTask", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/IssueAllWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/{id}/ReturnAll": { "post": { "tags": [ "Work Order Task" ], "summary": "Return all Items for Work Order Task 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| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "ReturnAllWorkOrderTask", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ReturnAllWorkOrderTaskResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/ValidateMeterAdr": { "post": { "tags": [ "Work Order Task" ], "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| workOrderId | ValidateWMMeterAdrEntity->WorkOrder_Id | integer | int64 |\r\n| meterId | ValidateWMMeterAdrEntity->Meter_Id | integer | int64 |\r\n| readingValue | ValidateWMMeterAdrEntity->ReadingValue | number | decimal |\r\n| readingOn | ValidateWMMeterAdrEntity->ReadingOn | string | date-time |\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| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n\r\n", "operationId": "ValidateWorkOrderTaskMeterAdr", "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/ValidateWorkOrderTaskMeterAdrResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task 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 | WorkOrderTask->Id | integer | int64 |\r\n| version | WorkOrderTask->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTask->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": "BatchChangeWorkOrderTaskPermissionTree", "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/BatchChangeWorkOrderTaskPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/AdHocCosts/{id}": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Get a Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskAdHocCost->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskAdHocCost->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskAdHocCost->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskAdHocCost->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskAdHocCost->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskAdHocCost->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskAdHocCost->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskAdHocCost->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskAdHocCost->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| code | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreId | WorkOrderTaskAdHocCost->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | WorkOrderTaskAdHocCost->CostCentre_Description | string | |\r\n| costCentreCode | WorkOrderTaskAdHocCost->CostCentre_Code | string | |\r\n| costElementId | WorkOrderTaskAdHocCost->CostElement_Id | integer | int64 |\r\n| costElementDescription | WorkOrderTaskAdHocCost->CostElement_Description | string | |\r\n| costElementCode | WorkOrderTaskAdHocCost->CostElement_Code | string | |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| currencyCode | WorkOrderTaskAdHocCost->Currency_Code | string | |\r\n| currencyDescription | WorkOrderTaskAdHocCost->Currency_Description | string | |\r\n| currencyRateId | WorkOrderTaskAdHocCost->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | WorkOrderTaskAdHocCost->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | WorkOrderTaskAdHocCost->CurrencyRateValue | number | decimal |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| financialYearPeriodId | WorkOrderTaskAdHocCost->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodDescription | WorkOrderTaskAdHocCost->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodCode | WorkOrderTaskAdHocCost->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | WorkOrderTaskAdHocCost->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | WorkOrderTaskAdHocCost->GeneralLedger_Description | string | |\r\n| generalLedgerCode | WorkOrderTaskAdHocCost->GeneralLedger_Code | string | |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| supplierDescription | WorkOrderTaskAdHocCost->Supplier_Description | string | |\r\n| supplierCode | WorkOrderTaskAdHocCost->Supplier_Code | string | |\r\n| totalCost | WorkOrderTaskAdHocCost->TotalCost | number | decimal |\r\n| totalCostInWorkOrderCurrency | WorkOrderTaskAdHocCost->TotalCostInWorkOrderCurrency | number | decimal |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| unitCostInWorkOrderCurrency | WorkOrderTaskAdHocCost->UnitCostInWorkOrderCurrency | number | decimal |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementDescription | WorkOrderTaskAdHocCost->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementCode | WorkOrderTaskAdHocCost->UnitOfMeasurement_Code | string | |\r\n| workOrderCurrencyId | WorkOrderTaskAdHocCost->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskAdHocCost->WorkOrderCurrency_Code | string | |\r\n| workOrderCurrencyDescription | WorkOrderTaskAdHocCost->WorkOrderCurrency_Description | string | |\r\n| workOrderTaskId | WorkOrderTaskAdHocCost->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskAdHocCost->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskAdHocCost->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskAdHocCost->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderTaskAdHocCost", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Ad Hoc Cost Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Ad Hoc Cost", "schema": { "$ref": "#/definitions/GetWorkOrderTaskAdHocCostResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Update an existing Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| code | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreId | WorkOrderTaskAdHocCost->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskAdHocCost->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| generalLedgerId | WorkOrderTaskAdHocCost->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskAdHocCost->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n| transactedOn | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| unitCost | Nullable | False | |\r\n| unitCost | Min Value | >= 0| |\r\n| currencyId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskAdHocCost", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Ad Hoc Cost Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskAdHocCostResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Ad Hoc Cost 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": [ "Work Order Task Ad Hoc Cost" ], "summary": "Delete an existing Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->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": "DeleteWorkOrderTaskAdHocCost", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Ad Hoc Cost Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskAdHocCostResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Ad Hoc Cost 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/WM/WorkOrders/Tasks/AdHocCosts/{workOrderTaskAdHocCostId}/Costing": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Get a collection of Costing resources for the Work Order Task Ad Hoc Cost.", "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 | Costing->Id | integer | int64 |\r\n| description | Costing->Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| baseCurrencyId | Costing->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | Costing->BaseCurrency_Code | string | |\r\n| conversionRateValue | Costing->ConversionRateValue | number | decimal |\r\n| unitPriceInSiteCurrency | Costing->UnitPriceInSiteCurrency | number | decimal |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| transactedOn | Costing->TransactedOn | string | date-time |\r\n| financialYearPeriodCode | Costing->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| workOrderId | Costing->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | Costing->WorkOrder_Code | string | |\r\n| workOrderDescription | Costing->WorkOrder_Description | string | |\r\n| permissionTreeId | Costing->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Costing->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Costing->PermissionTree_Description | string | |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n| assetTypeId | Costing->AssetType_Id | integer | int64 |\r\n| assetTypeCode | Costing->AssetType_Code | string | |\r\n| assetTypeDescription | Costing->AssetType_Description | string | |\r\n| assetTypeRecordType | Costing->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderAssetId | Costing->WorkOrderAsset_Id | integer | int64 |\r\n| workOrderAssetCode | Costing->WorkOrderAsset_Code | string | |\r\n| workOrderAssetDescription | Costing->WorkOrderAsset_Description | string | |\r\n| workOrderAssetRecordType | Costing->WorkOrderAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskAssetId | Costing->WorkOrderTaskAsset_Id | integer | int64 |\r\n| workOrderTaskAssetCode | Costing->WorkOrderTaskAsset_Code | string | |\r\n| workOrderTaskAssetDescription | Costing->WorkOrderTaskAsset_Description | string | |\r\n| workOrderTaskAssetRecordType | Costing->WorkOrderTaskAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| workOrderTaskAdHocCostId | Costing->WorkOrderTaskAdHocCost_Id | integer | int64 |\r\n| workOrderTaskAdHocCostCode | Costing->WorkOrderTaskAdHocCost_Code | string | |\r\n| workOrderTaskAdHocCostDescription | Costing->WorkOrderTaskAdHocCost_Description | string | |\r\n", "operationId": "GetCostingCollectionForWorkOrderTaskAdHocCostCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskAdHocCostId", "in": "path", "required": true, "description": "Work Order Task Ad Hoc Cost 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 Work Order Task Ad Hoc Cost collection", "schema": { "$ref": "#/definitions/GetCostingCollectionForWorkOrderTaskAdHocCostResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Get a collection of Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| version | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| code | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreCode | WorkOrderTaskAdHocCost->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrderTaskAdHocCost->CostCentre_Description | string | |\r\n| costElementCode | WorkOrderTaskAdHocCost->CostElement_Code | string | |\r\n| costElementDescription | WorkOrderTaskAdHocCost->CostElement_Description | string | |\r\n| currencyRateValue | WorkOrderTaskAdHocCost->CurrencyRateValue | number | decimal |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| generalLedgerCode | WorkOrderTaskAdHocCost->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrderTaskAdHocCost->GeneralLedger_Description | string | |\r\n| financialYearPeriodCode | WorkOrderTaskAdHocCost->FinancialYearPeriod_Code | string | |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskAdHocCost->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskAdHocCost->PermissionTree_Description | string | |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| totalCostInWorkOrderCurrency | WorkOrderTaskAdHocCost->TotalCostInWorkOrderCurrency | number | decimal |\r\n| totalCost | WorkOrderTaskAdHocCost->TotalCost | number | decimal |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| unitCostInWorkOrderCurrency | WorkOrderTaskAdHocCost->UnitCostInWorkOrderCurrency | number | decimal |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| currencyCode | WorkOrderTaskAdHocCost->Currency_Code | string | |\r\n| currencyDescription | WorkOrderTaskAdHocCost->Currency_Description | string | |\r\n| workOrderCurrencyId | WorkOrderTaskAdHocCost->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskAdHocCost->WorkOrderCurrency_Code | string | |\r\n| workOrderCurrencyDescription | WorkOrderTaskAdHocCost->WorkOrderCurrency_Description | string | |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| supplierCode | WorkOrderTaskAdHocCost->Supplier_Code | string | |\r\n| supplierDescription | WorkOrderTaskAdHocCost->Supplier_Description | string | |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskAdHocCost->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskAdHocCost->UnitOfMeasurement_Description | string | |\r\n| workOrderTaskId | WorkOrderTaskAdHocCost->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderStatusId | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskWorkOrderStatusCode | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Status_Code | string | |\r\n| workOrderTaskWorkOrderStatusDescription | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Status_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskAdHocCost->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskAdHocCost->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskAdHocCost->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n", "operationId": "GetWorkOrderTaskAdHocCostCollection", "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 Work Order Task Ad Hoc Cost collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskAdHocCostCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Create a new Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreId | WorkOrderTaskAdHocCost->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskAdHocCost->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| generalLedgerId | WorkOrderTaskAdHocCost->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskAdHocCost->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->PermissionTree_Id | integer | int64 |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskAdHocCost->WorkOrderTask_Id | integer | int64 |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| transactedOn | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| unitCost | Nullable | False | |\r\n| unitCost | Min Value | >= 0| |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTaskAdHocCost", "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/CreateWorkOrderTaskAdHocCostResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/{workOrderTaskId}/AdHocCosts": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Get a collection of Work Order Task Ad Hoc Cost resources for the Work Order Task", "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 | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreCode | WorkOrderTaskAdHocCost->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrderTaskAdHocCost->CostCentre_Description | string | |\r\n| costElementCode | WorkOrderTaskAdHocCost->CostElement_Code | string | |\r\n| costElementDescription | WorkOrderTaskAdHocCost->CostElement_Description | string | |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| generalLedgerCode | WorkOrderTaskAdHocCost->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrderTaskAdHocCost->GeneralLedger_Description | string | |\r\n| id | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| supplierCode | WorkOrderTaskAdHocCost->Supplier_Code | string | |\r\n| supplierDescription | WorkOrderTaskAdHocCost->Supplier_Description | string | |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskAdHocCost->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskAdHocCost->UnitOfMeasurement_Description | string | |\r\n| version | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskAdHocCostForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Ad Hoc Cost collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskAdHocCostForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostChangePermissionTree": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the permission set for changing the Work Order Task Ad Hoc Cost.", "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": "LookupWorkOrderTaskAdHocCostChangePermissionTree", "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/WorkOrderTaskAdHocCostChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostCostCentre": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Cost Centre for the Work Order Task Ad Hoc Cost.", "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 | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskAdHocCostCostCentre", "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 Cost Centre collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAdHocCostCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostCostElement": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Cost Element for the Work Order Task Ad Hoc Cost.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskAdHocCostCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAdHocCostCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostFinancialYearPeriod": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Financial Year Period for the Work Order Task Ad Hoc Cost.", "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 | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskAdHocCostFinancialYearPeriod", "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 Financial Year Period collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAdHocCostFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostGeneralLedger": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the General Ledger for the Work Order Task Ad Hoc Cost.", "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 | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskAdHocCostGeneralLedger", "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 General Ledger collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAdHocCostGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostInsertPermissionTree": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the permission set for creating the Work Order Task Ad Hoc Cost.", "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": "LookupWorkOrderTaskAdHocCostInsertPermissionTree", "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/WorkOrderTaskAdHocCostInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostSourceCurrency": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Currency for the Work Order Task Ad Hoc Cost.", "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": "LookupWorkOrderTaskAdHocCostSourceCurrency", "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/WorkOrderTaskAdHocCostSourceCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostSupplier": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Supplier for the Work Order Task Ad Hoc Cost.", "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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n| siteCurrencyId | Supplier->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | Supplier->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | Supplier->Site_Currency_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskAdHocCostSupplier", "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 Supplier collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAdHocCostSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostUnitOfMeasurement": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Unit Of Measurement for the Work Order Task Ad Hoc Cost.", "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": "LookupWorkOrderTaskAdHocCostUnitOfMeasurement", "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/WorkOrderTaskAdHocCostUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Lookups/LookupWorkOrderTaskAdHocCostWorkOrderTask": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Lookup the Work Order Task for the Work Order Task Ad Hoc Cost.", "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 | WorkOrderTask->Id | integer | int64 |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| workOrderRequiredBy | WorkOrderTask->WorkOrder_RequiredBy | string | date-time |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n", "operationId": "LookupWorkOrderTaskAdHocCostWorkOrderTask", "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 Work Order Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskAdHocCostWorkOrderTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Batch/{ids}": { "get": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Get a collection of Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskAdHocCost->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskAdHocCost->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskAdHocCost->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskAdHocCost->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskAdHocCost->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskAdHocCost->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskAdHocCost->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskAdHocCost->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskAdHocCost->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| code | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreId | WorkOrderTaskAdHocCost->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | WorkOrderTaskAdHocCost->CostCentre_Description | string | |\r\n| costCentreCode | WorkOrderTaskAdHocCost->CostCentre_Code | string | |\r\n| costElementId | WorkOrderTaskAdHocCost->CostElement_Id | integer | int64 |\r\n| costElementDescription | WorkOrderTaskAdHocCost->CostElement_Description | string | |\r\n| costElementCode | WorkOrderTaskAdHocCost->CostElement_Code | string | |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| currencyCode | WorkOrderTaskAdHocCost->Currency_Code | string | |\r\n| currencyDescription | WorkOrderTaskAdHocCost->Currency_Description | string | |\r\n| currencyRateId | WorkOrderTaskAdHocCost->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | WorkOrderTaskAdHocCost->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | WorkOrderTaskAdHocCost->CurrencyRateValue | number | decimal |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| financialYearPeriodId | WorkOrderTaskAdHocCost->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodDescription | WorkOrderTaskAdHocCost->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodCode | WorkOrderTaskAdHocCost->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | WorkOrderTaskAdHocCost->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | WorkOrderTaskAdHocCost->GeneralLedger_Description | string | |\r\n| generalLedgerCode | WorkOrderTaskAdHocCost->GeneralLedger_Code | string | |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| supplierDescription | WorkOrderTaskAdHocCost->Supplier_Description | string | |\r\n| supplierCode | WorkOrderTaskAdHocCost->Supplier_Code | string | |\r\n| totalCost | WorkOrderTaskAdHocCost->TotalCost | number | decimal |\r\n| totalCostInWorkOrderCurrency | WorkOrderTaskAdHocCost->TotalCostInWorkOrderCurrency | number | decimal |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| unitCostInWorkOrderCurrency | WorkOrderTaskAdHocCost->UnitCostInWorkOrderCurrency | number | decimal |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementDescription | WorkOrderTaskAdHocCost->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementCode | WorkOrderTaskAdHocCost->UnitOfMeasurement_Code | string | |\r\n| workOrderCurrencyId | WorkOrderTaskAdHocCost->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskAdHocCost->WorkOrderCurrency_Code | string | |\r\n| workOrderCurrencyDescription | WorkOrderTaskAdHocCost->WorkOrderCurrency_Description | string | |\r\n| workOrderTaskId | WorkOrderTaskAdHocCost->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskAdHocCost->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskAdHocCost->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskAdHocCost->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderTaskAdHocCost", "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 Work Order Task Ad Hoc Cost 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 Work Order Task Ad Hoc Cost collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskAdHocCostResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/AdHocCosts/Batch": { "post": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Create a new collection of Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreId | WorkOrderTaskAdHocCost->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskAdHocCost->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| generalLedgerId | WorkOrderTaskAdHocCost->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskAdHocCost->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->PermissionTree_Id | integer | int64 |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskAdHocCost->WorkOrderTask_Id | integer | int64 |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n| transactedOn | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| unitCost | Nullable | False | |\r\n| unitCost | Min Value | >= 0| |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderTaskAdHocCost", "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/BatchCreateWorkOrderTaskAdHocCostResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task Ad Hoc Cost 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": [ "Work Order Task Ad Hoc Cost" ], "summary": "Update a collection of existing Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| version | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| code | WorkOrderTaskAdHocCost->Code | string | |\r\n| costCentreId | WorkOrderTaskAdHocCost->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskAdHocCost->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskAdHocCost->Description | string | |\r\n| generalLedgerId | WorkOrderTaskAdHocCost->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskAdHocCost->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | WorkOrderTaskAdHocCost->TransactedOn | string | date-time |\r\n| quantity | WorkOrderTaskAdHocCost->Quantity | number | decimal |\r\n| unitCost | WorkOrderTaskAdHocCost->UnitCost | number | decimal |\r\n| currencyId | WorkOrderTaskAdHocCost->Currency_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskAdHocCost->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskAdHocCost->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n| transactedOn | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| unitCost | Nullable | False | |\r\n| unitCost | Min Value | >= 0| |\r\n| currencyId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskAdHocCost", "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/BatchUpdateWorkOrderTaskAdHocCostResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Ad Hoc Cost 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": [ "Work Order Task Ad Hoc Cost" ], "summary": "Delete a collection of existing Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| version | WorkOrderTaskAdHocCost->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": "BatchDeleteWorkOrderTaskAdHocCost", "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/BatchDeleteWorkOrderTaskAdHocCostResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Ad Hoc Cost 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/WM/WorkOrders/Tasks/AdHocCosts/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Change the PermissionTree for an existing Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->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": "ChangeWorkOrderTaskAdHocCostPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Ad Hoc Cost Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/AdHocCosts/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task Ad Hoc Cost" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task Ad Hoc Cost 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 | WorkOrderTaskAdHocCost->Id | integer | int64 |\r\n| version | WorkOrderTaskAdHocCost->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskAdHocCost->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": "BatchChangeWorkOrderTaskAdHocCostPermissionTree", "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/BatchChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Documents/{id}": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Get a Work Order Task 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| isCopiedDocumentLink | WorkOrderTaskDocument->IsCopiedDocumentLink | boolean | |\r\n| workOrderTaskId | WorkOrderTaskDocument->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskDocument->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskDocument->WorkOrderTask_TaskDescription | string | |\r\n| isActive | WorkOrderTaskDocument->IsActive | boolean | |\r\n| createdByUserId | WorkOrderTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskDocument->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskDocument->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskDocument->Id | integer | int64 |\r\n| documentRecordId | WorkOrderTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkOrderTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkOrderTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkOrderTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkOrderTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkOrderTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkOrderTaskDocument->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Document", "schema": { "$ref": "#/definitions/GetWorkOrderTaskDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Document" ], "summary": "Update an existing Work Order Task 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 | WorkOrderTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderTaskDocument->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": "UpdateWorkOrderTaskDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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": [ "Work Order Task Document" ], "summary": "Delete an existing Work Order Task 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 | WorkOrderTaskDocument->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": "DeleteWorkOrderTaskDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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/WM/WorkOrders/Tasks/{id}/Documents": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Get a collection of Work Order Task Document resources for the Work Order Task.", "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 | WorkOrderTaskDocument->Id | integer | int64 |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkOrderTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkOrderTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkOrderTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| isCopiedDocumentLink | WorkOrderTaskDocument->IsCopiedDocumentLink | boolean | |\r\n", "operationId": "GetWorkOrderTaskDocumentCollectionForWorkOrderTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Document collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskDocumentCollectionForWorkOrderTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Documents": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Get a collection of Work Order Task 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 | WorkOrderTaskDocument->Id | integer | int64 |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| workOrderTaskId | WorkOrderTaskDocument->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskDocument->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskDocument->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskDocument->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskDocument->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskDocument->WorkOrderTask_WorkOrder_Description | string | |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkOrderTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkOrderTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkOrderTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| isCopiedDocumentLink | WorkOrderTaskDocument->IsCopiedDocumentLink | boolean | |\r\n", "operationId": "GetWorkOrderTaskDocumentCollection", "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 Work Order Task Document collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Task Document" ], "summary": "Create a new Work Order Task 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| workOrderTaskId | WorkOrderTaskDocument->WorkOrderTask_Id | integer | int64 |\r\n| documentRecordId | WorkOrderTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderTaskDocument->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| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | 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": "CreateWorkOrderTaskDocument", "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/CreateWorkOrderTaskDocumentResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Documents/Lookups/LookupWorkOrderTaskDocumentChangePermissionTree": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Lookup the permission set for changing the Work Order Task 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": "LookupWorkOrderTaskDocumentChangePermissionTree", "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/WorkOrderTaskDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Documents/Lookups/LookupWorkOrderTaskDocument": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Work Order Task Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupWorkOrderTaskDocument", "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/WorkOrderTaskDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Documents/Lookups/LookupWorkOrderTaskDocumentInsertPermissionTree": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Lookup the permission set for creating the Work Order Task 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": "LookupWorkOrderTaskDocumentInsertPermissionTree", "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/WorkOrderTaskDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Documents/Lookups/LookupWorkOrderTaskDocumentWorkOrderTask": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Lookup the Work Order Task Document for the Work Order Task 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 | WorkOrderTask->Id | integer | int64 |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n", "operationId": "LookupWorkOrderTaskDocumentWorkOrderTask", "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 Work Order Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskDocumentWorkOrderTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Documents/Batch/{ids}": { "get": { "tags": [ "Work Order Task Document" ], "summary": "Get a collection of Work Order Task 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| isCopiedDocumentLink | WorkOrderTaskDocument->IsCopiedDocumentLink | boolean | |\r\n| workOrderTaskId | WorkOrderTaskDocument->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskDocument->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskDocument->WorkOrderTask_TaskDescription | string | |\r\n| isActive | WorkOrderTaskDocument->IsActive | boolean | |\r\n| createdByUserId | WorkOrderTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskDocument->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskDocument->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskDocument->Id | integer | int64 |\r\n| documentRecordId | WorkOrderTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkOrderTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkOrderTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkOrderTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkOrderTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkOrderTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkOrderTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkOrderTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkOrderTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkOrderTaskDocument->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderTaskDocument", "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 Work Order Task 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 Work Order Task Document collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Documents/Batch": { "post": { "tags": [ "Work Order Task Document" ], "summary": "Create a new collection of Work Order Task 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| workOrderTaskId | WorkOrderTaskDocument->WorkOrderTask_Id | integer | int64 |\r\n| documentRecordId | WorkOrderTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderTaskDocument->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| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | 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": "BatchCreateWorkOrderTaskDocument", "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/BatchCreateWorkOrderTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task 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": [ "Work Order Task Document" ], "summary": "Update a collection of existing Work Order Task 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 | WorkOrderTaskDocument->Id | integer | int64 |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkOrderTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkOrderTaskDocument->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": "BatchUpdateWorkOrderTaskDocument", "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/BatchUpdateWorkOrderTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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": [ "Work Order Task Document" ], "summary": "Delete a collection of existing Work Order Task 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 | WorkOrderTaskDocument->Id | integer | int64 |\r\n| version | WorkOrderTaskDocument->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": "BatchDeleteWorkOrderTaskDocument", "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/BatchDeleteWorkOrderTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task 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/WM/WorkOrders/Tasks/Documents/{id}/Active": { "patch": { "tags": [ "Work Order Task Document" ], "summary": "Change the IsActive status for an existing Work Order Task 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 | WorkOrderTaskDocument->Version | integer | int32 |\r\n| isActive | WorkOrderTaskDocument->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": "ChangeWorkOrderTaskDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task Document" ], "summary": "Change the PermissionTree for an existing Work Order Task 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 | WorkOrderTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskDocument->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": "ChangeWorkOrderTaskDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task Document" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task 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 | WorkOrderTaskDocument->Id | integer | int64 |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskDocument->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": "BatchChangeWorkOrderTaskDocumentPermissionTree", "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/BatchChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Documents/Batch/Active": { "patch": { "tags": [ "Work Order Task Document" ], "summary": "Change the IsActive status for a collection of existing Work Order Task 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 | WorkOrderTaskDocument->Id | integer | int64 |\r\n| version | WorkOrderTaskDocument->Version | integer | int32 |\r\n| isActive | WorkOrderTaskDocument->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": "BatchChangeWorkOrderTaskDocumentIsActive", "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/BatchChangeWorkOrderTaskDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/FileAttachments/{id}/Download": { "get": { "tags": [ "Work Order Task File Attachment" ], "summary": "Download the content for a Work Order Task File Attachment resource.", "description": "", "operationId": "GetWorkOrderTaskFileAttachmentContent", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of attachment content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/{id}": { "get": { "tags": [ "Work Order Task File Attachment" ], "summary": "Get a Work Order Task File Attachment 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| workOrderTaskId | WorkOrderTaskFileAttachment->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskFileAttachment->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskFileAttachment->WorkOrderTask_TaskDescription | string | |\r\n| createdByUserId | WorkOrderTaskFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkOrderTaskFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkOrderTaskFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkOrderTaskFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkOrderTaskFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkOrderTaskFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkOrderTaskFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkOrderTaskFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkOrderTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkOrderTaskFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkOrderTaskFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkOrderTaskFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkOrderTaskFileAttachment->FileFullName | string | |\r\n| fileName | WorkOrderTaskFileAttachment->FileName | string | |\r\n| fileTypeId | WorkOrderTaskFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkOrderTaskFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| id | WorkOrderTaskFileAttachment->Id | integer | int64 |\r\n| isActive | WorkOrderTaskFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderTaskFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskFileAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task File Attachment", "schema": { "$ref": "#/definitions/GetWorkOrderTaskFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task File Attachment" ], "summary": "Update an existing Work Order Task File Attachment 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 | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | WorkOrderTaskFileAttachment->FileName | string | |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | 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| fileName | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskFileAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task File Attachment 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": [ "Work Order Task File Attachment" ], "summary": "Delete an existing Work Order Task File Attachment 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 | WorkOrderTaskFileAttachment->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": "DeleteWorkOrderTaskFileAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task File Attachment 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/WM/WorkOrders/Tasks/{id}/FileAttachments": { "get": { "tags": [ "Work Order Task File Attachment" ], "summary": "Get a collection of Work Order Task File Attachment resources for the Work Order Task.", "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 | WorkOrderTaskFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n| fileFullName | WorkOrderTaskFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkOrderTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkOrderTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkOrderTaskFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderTaskFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderTaskFileAttachmentCollectionForWorkOrderTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "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 Work Order Task File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskFileAttachmentCollectionForWorkOrderTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments": { "get": { "tags": [ "Work Order Task File Attachment" ], "summary": "Get a collection of Work Order Task File Attachment 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 | WorkOrderTaskFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n| workOrderTaskId | WorkOrderTaskFileAttachment->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskFileAttachment->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskFileAttachment->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskFileAttachment->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskFileAttachment->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskFileAttachment->WorkOrderTask_WorkOrder_Description | string | |\r\n| fileFullName | WorkOrderTaskFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkOrderTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | WorkOrderTaskFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkOrderTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkOrderTaskFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderTaskFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderTaskFileAttachmentCollection", "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 Work Order Task File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/Upload": { "post": { "tags": [ "Work Order Task File Attachment" ], "summary": "Upload and create a new Work Order Task File Attachment 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| workOrderTaskId | WorkOrderTaskFileAttachment->WorkOrderTask_Id | integer | int64 |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderTaskFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkOrderTaskFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTaskFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateWorkOrderTaskFileAttachmentResourceActionRequest" } } ], "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" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/{id}/Upload": { "put": { "tags": [ "Work Order Task File Attachment" ], "summary": "Upload new content for an existing Work Order Task File Attachment 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 | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n| bytes | WorkOrderTaskFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskFileAttachmentContent", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Work Order Task File Attachment" ], "summary": "Get a collection of Work Order Task File Attachment 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| workOrderTaskId | WorkOrderTaskFileAttachment->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskFileAttachment->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskFileAttachment->WorkOrderTask_TaskDescription | string | |\r\n| createdByUserId | WorkOrderTaskFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkOrderTaskFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkOrderTaskFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkOrderTaskFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkOrderTaskFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkOrderTaskFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkOrderTaskFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkOrderTaskFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkOrderTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkOrderTaskFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkOrderTaskFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkOrderTaskFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkOrderTaskFileAttachment->FileFullName | string | |\r\n| fileName | WorkOrderTaskFileAttachment->FileName | string | |\r\n| fileTypeId | WorkOrderTaskFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkOrderTaskFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| id | WorkOrderTaskFileAttachment->Id | integer | int64 |\r\n| isActive | WorkOrderTaskFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderTaskFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderTaskFileAttachment", "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 Work Order Task File Attachment 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 Work Order Task File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Work Order Task File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Work Order Task File Attachment.", "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 | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetWorkOrderTaskFileAttachmentContentHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/Upload/Batch": { "post": { "tags": [ "Work Order Task File Attachment" ], "summary": "Upload and create a new collection of Work Order Task File Attachment 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| workOrderTaskId | WorkOrderTaskFileAttachment->WorkOrderTask_Id | integer | int64 |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderTaskFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkOrderTaskFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderTaskFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateWorkOrderTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/FileAttachments/Batch": { "patch": { "tags": [ "Work Order Task File Attachment" ], "summary": "Update a collection of existing Work Order Task File Attachment 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 | WorkOrderTaskFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskFileAttachment->Version | integer | int32 |\r\n| isRestricted | WorkOrderTaskFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderTaskFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderTaskFileAttachment->FileCategory_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| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskFileAttachment", "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/BatchUpdateWorkOrderTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task File Attachment 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": [ "Work Order Task File Attachment" ], "summary": "Delete a collection of existing Work Order Task File Attachment 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 | WorkOrderTaskFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskFileAttachment->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": "BatchDeleteWorkOrderTaskFileAttachment", "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/BatchDeleteWorkOrderTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task File Attachment 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/WM/WorkOrders/Tasks/MonitoringPoints/{id}": { "get": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Get a Work Order Task Monitoring Point resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | WorkOrderTaskMonitoringPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskMonitoringPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskMonitoringPoint->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskMonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskMonitoringPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskMonitoringPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskMonitoringPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskMonitoringPoint->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMonitoringPoint->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskMonitoringPoint->Id | integer | int64 |\r\n| monitoringPointId | WorkOrderTaskMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | WorkOrderTaskMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | WorkOrderTaskMonitoringPoint->MonitoringPoint_Description | string | |\r\n| monitoringPointReading | WorkOrderTaskMonitoringPoint->MonitoringPointReading | number | decimal |\r\n| monitoringPointReadingDate | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| notes | WorkOrderTaskMonitoringPoint->Notes | string | |\r\n| workOrderMonitoringPointId | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_Id | integer | int64 |\r\n| workOrderMonitoringPointMonitoringPointReadingDate | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_MonitoringPointReadingDate | string | date-time |\r\n| workOrderMonitoringPointMonitoringPointReadingValue | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_MonitoringPointReadingValue | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskMonitoringPoint->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderTaskMonitoringPoint", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Monitoring Point Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Monitoring Point", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMonitoringPointResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Update an existing Work Order Task Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| notes | WorkOrderTaskMonitoringPoint->Notes | string | |\r\n| monitoringPointReadingDate | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| monitoringPointReading | WorkOrderTaskMonitoringPoint->MonitoringPointReading | 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| monitoringPointReading | Nullable | False | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate ne null |\r\n| monitoringPointReading | Nullable | True | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate eq null |\r\n\r\n", "operationId": "UpdateWorkOrderTaskMonitoringPoint", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Monitoring Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskMonitoringPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Monitoring Point 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/WM/WorkOrders/Tasks/MonitoringPoints": { "get": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Get a collection of Work Order Task Monitoring Point resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTaskMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMonitoringPoint->PermissionTree_Description | string | |\r\n| monitoringPointReading | WorkOrderTaskMonitoringPoint->MonitoringPointReading | number | decimal |\r\n| monitoringPointCode | WorkOrderTaskMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | WorkOrderTaskMonitoringPoint->MonitoringPoint_Description | string | |\r\n| monitoringPointReadingDate | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode | string | |\r\n", "operationId": "GetWorkOrderTaskMonitoringPointCollection", "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 Work Order Task Monitoring Point collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMonitoringPointCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/{workOrderTaskId}/MonitoringPoints": { "get": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Get a collection of Work Order Task Monitoring Point resources for the Work Order Task", "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 | WorkOrderTaskMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMonitoringPoint->PermissionTree_Description | string | |\r\n| monitoringPointReading | WorkOrderTaskMonitoringPoint->MonitoringPointReading | number | decimal |\r\n| monitoringPointCode | WorkOrderTaskMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointReadingDate | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| workOrderMonitoringPointUpperCriticalBound | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_UpperCriticalBound | number | decimal |\r\n| workOrderMonitoringPointUpperWarningBound | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_UpperWarningBound | number | decimal |\r\n| workOrderMonitoringPointLowerWarningBound | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_LowerWarningBound | number | decimal |\r\n| workOrderMonitoringPointLowerCriticalBound | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_LowerCriticalBound | number | decimal |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode | string | |\r\n", "operationId": "GetWorkOrderTaskMonitoringPointForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Monitoring Point collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMonitoringPointForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/MonitoringPoints/Lookups/LookupWorkOrderTaskMonitoringPointChangePermissionTree": { "get": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Lookup the permission set for changing the Work Order Task Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupWorkOrderTaskMonitoringPointChangePermissionTree", "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/WorkOrderTaskMonitoringPointChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/MonitoringPoints/Lookups/LookupWorkOrderTaskMonitoringPointInsertPermissionTree": { "get": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Lookup the permission set for creating the Work Order Task Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupWorkOrderTaskMonitoringPointInsertPermissionTree", "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/WorkOrderTaskMonitoringPointInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/MonitoringPoints/Batch/{ids}": { "get": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Get a collection of Work Order Task Monitoring Point resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | WorkOrderTaskMonitoringPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskMonitoringPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskMonitoringPoint->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskMonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskMonitoringPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskMonitoringPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskMonitoringPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskMonitoringPoint->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskMonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskMonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMonitoringPoint->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskMonitoringPoint->Id | integer | int64 |\r\n| monitoringPointId | WorkOrderTaskMonitoringPoint->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | WorkOrderTaskMonitoringPoint->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | WorkOrderTaskMonitoringPoint->MonitoringPoint_Description | string | |\r\n| monitoringPointReading | WorkOrderTaskMonitoringPoint->MonitoringPointReading | number | decimal |\r\n| monitoringPointReadingDate | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| notes | WorkOrderTaskMonitoringPoint->Notes | string | |\r\n| workOrderMonitoringPointId | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_Id | integer | int64 |\r\n| workOrderMonitoringPointMonitoringPointReadingDate | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_MonitoringPointReadingDate | string | date-time |\r\n| workOrderMonitoringPointMonitoringPointReadingValue | WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_MonitoringPointReadingValue | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskMonitoringPoint->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderTaskMonitoringPoint", "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 Work Order Task Monitoring Point 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 Work Order Task Monitoring Point collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskMonitoringPointResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/MonitoringPoints/Batch": { "patch": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Update a collection of existing Work Order Task Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTaskMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| notes | WorkOrderTaskMonitoringPoint->Notes | string | |\r\n| monitoringPointReadingDate | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate | string | date-time |\r\n| monitoringPointReading | WorkOrderTaskMonitoringPoint->MonitoringPointReading | 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| monitoringPointReading | Nullable | False | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate ne null |\r\n| monitoringPointReading | Nullable | True | WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate eq null |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskMonitoringPoint", "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/BatchUpdateWorkOrderTaskMonitoringPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Monitoring Point 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/WM/WorkOrders/Tasks/MonitoringPoints/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Change the PermissionTree for an existing Work Order Task Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskMonitoringPoint->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": "ChangeWorkOrderTaskMonitoringPointPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Monitoring Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/MonitoringPoints/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task Monitoring Point" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTaskMonitoringPoint->Id | integer | int64 |\r\n| version | WorkOrderTaskMonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskMonitoringPoint->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": "BatchChangeWorkOrderTaskMonitoringPointPermissionTree", "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/BatchChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Movements/{id}": { "get": { "tags": [ "Work Order Task Movement" ], "summary": "Get a Work Order Task Movement 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 | WorkOrderTaskMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskMovement->WorkOrder_Code | string | |\r\n| workOrderMovementId | WorkOrderTaskMovement->WorkOrderMovement_Id | integer | int64 |\r\n| workOrderMovementWorkOrderId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Id | integer | int64 |\r\n| workOrderMovementWorkOrderCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code | string | |\r\n| workOrderMovementWorkOrderDescription | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Description | string | |\r\n| workOrderMovementWorkOrderWorkRequired | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_WorkRequired | string | |\r\n| workOrderMovementWorkOrderRequiredBy | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_RequiredBy | string | date-time |\r\n| workOrderMovementWorkOrderSiteId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Site_Id | integer | int64 |\r\n| workOrderMovementWorkOrderSiteCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Site_Code | string | |\r\n| workOrderMovementWorkOrderCostCentreId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderMovementWorkOrderCostCentreCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_CostCentre_Code | string | |\r\n| workOrderMovementWorkOrderGeneralLedgerId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderMovementWorkOrderGeneralLedgerCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderMovementWorkOrderStatusId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderMovementWorkOrderStatusCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_Code | string | |\r\n| workOrderMovementWorkOrderStatusBaseStatus | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderTaskId | WorkOrderTaskMovement->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskMovement->WorkOrderTask_TaskCode | string | |\r\n", "operationId": "GetWorkOrderTaskMovement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Movement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Movement", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMovementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Movements": { "get": { "tags": [ "Work Order Task Movement" ], "summary": "Get a collection of Work Order Task Movement 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 | WorkOrderTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskMovement->Version | integer | int32 |\r\n| workOrderCode | WorkOrderTaskMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskMovement->WorkOrder_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskMovement->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskMovement->WorkOrderTask_TaskDescription | string | |\r\n| action | WorkOrderTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskMovementCollection", "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 Work Order Task Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Movements/{workOrderMovementId}/Tasks": { "get": { "tags": [ "Work Order Task Movement" ], "summary": "Get a collection of Work Order Task Movement resources for the Work Order Movement.", "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 | WorkOrderTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskMovement->WorkOrder_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskMovement->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskMovement->WorkOrderTask_TaskDescription | string | |\r\n| action | WorkOrderTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskMovementForWorkOrderMovementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderMovementId", "in": "path", "required": true, "description": "Work Order Movement 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 Work Order Task Movement collection", "schema": { "$ref": "#/definitions/GetTaskForWorkOrderMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/{workOrderTaskId}/Movements": { "get": { "tags": [ "Work Order Task Movement" ], "summary": "Get a collection of Work Order Task Movement resources for the Work Order Task.", "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 | WorkOrderTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskMovement->Version | integer | int32 |\r\n| workOrderTaskTaskCode | WorkOrderTaskMovement->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskMovement->WorkOrderTask_TaskDescription | string | |\r\n| action | WorkOrderTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| createdOn | WorkOrderTaskMovement->CreatedOn | string | date-time |\r\n| workOrderMovementCreatedOn | WorkOrderTaskMovement->WorkOrderMovement_CreatedOn | string | date-time |\r\n| workOrderMovementCreatedByUserFullName | WorkOrderTaskMovement->WorkOrderMovement_CreatedByUser_FullName | string | |\r\n| workOrderMovementWorkOrderCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code | string | |\r\n| workOrderCode | WorkOrderTaskMovement->WorkOrder_Code | string | |\r\n", "operationId": "GetWorkOrderTaskMovementForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskMovementForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Movements/Batch/{ids}": { "get": { "tags": [ "Work Order Task Movement" ], "summary": "Get a collection of Work Order Task Movement 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 | WorkOrderTaskMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskMovement->WorkOrder_Code | string | |\r\n| workOrderMovementId | WorkOrderTaskMovement->WorkOrderMovement_Id | integer | int64 |\r\n| workOrderMovementWorkOrderId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Id | integer | int64 |\r\n| workOrderMovementWorkOrderCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code | string | |\r\n| workOrderMovementWorkOrderDescription | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Description | string | |\r\n| workOrderMovementWorkOrderWorkRequired | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_WorkRequired | string | |\r\n| workOrderMovementWorkOrderRequiredBy | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_RequiredBy | string | date-time |\r\n| workOrderMovementWorkOrderSiteId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Site_Id | integer | int64 |\r\n| workOrderMovementWorkOrderSiteCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Site_Code | string | |\r\n| workOrderMovementWorkOrderCostCentreId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_CostCentre_Id | integer | int64 |\r\n| workOrderMovementWorkOrderCostCentreCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_CostCentre_Code | string | |\r\n| workOrderMovementWorkOrderGeneralLedgerId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_GeneralLedger_Id | integer | int64 |\r\n| workOrderMovementWorkOrderGeneralLedgerCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_GeneralLedger_Code | string | |\r\n| workOrderMovementWorkOrderStatusId | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderMovementWorkOrderStatusCode | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_Code | string | |\r\n| workOrderMovementWorkOrderStatusBaseStatus | WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| workOrderTaskId | WorkOrderTaskMovement->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskMovement->WorkOrderTask_TaskCode | string | |\r\n", "operationId": "BatchGetWorkOrderTaskMovement", "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 Work Order Task Movement 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 Work Order Task Movement collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskMovementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/{id}": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Get a Work Order Task Resource 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 | WorkOrderTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskResource->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResource->PermissionTree_Description | string | |\r\n| disabledReasons | WorkOrderTaskResource->DisabledReasons | array | enum |\r\n| id | WorkOrderTaskResource->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskResource->IsEnabled | boolean | |\r\n| workOrderTaskId | WorkOrderTaskResource->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskResource->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskResource->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskResource->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderStatusId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskWorkOrderStatusBaseStatus | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | WorkOrderTaskResource->Competency_Code | string | |\r\n| competencyDescription | WorkOrderTaskResource->Competency_Description | string | |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | WorkOrderTaskResource->CostCentre_Description | string | |\r\n| costCentreCode | WorkOrderTaskResource->CostCentre_Code | string | |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| costElementDescription | WorkOrderTaskResource->CostElement_Description | string | |\r\n| costElementCode | WorkOrderTaskResource->CostElement_Code | string | |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | WorkOrderTaskResource->GeneralLedger_Description | string | |\r\n| generalLedgerCode | WorkOrderTaskResource->GeneralLedger_Code | string | |\r\n| notes | WorkOrderTaskResource->Notes | string | |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | WorkOrderTaskResource->Resource_Code | string | |\r\n| resourceDescription | WorkOrderTaskResource->Resource_Description | string | |\r\n| resourceTotalCostInResourceCurrency | WorkOrderTaskResource->ResourceTotalCostInResourceCurrency | number | decimal |\r\n| resourceTotalCostInWorkOrderCurrency | WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency | number | decimal |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrderTaskResource->Section_Code | string | |\r\n| sectionDescription | WorkOrderTaskResource->Section_Description | string | |\r\n| sequenceNumber | WorkOrderTaskResource->SequenceNumber | integer | int32 |\r\n| taskResourceId | WorkOrderTaskResource->TaskResourceId | integer | int64 |\r\n| taskResourceType | WorkOrderTaskResource->TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| tradeDescription | WorkOrderTaskResource->Trade_Description | string | |\r\n| tradeCode | WorkOrderTaskResource->Trade_Code | string | |\r\n| unitOfMeasurementId | WorkOrderTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | WorkOrderTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "GetWorkOrderTaskResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Resource", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Resource" ], "summary": "Update an existing Work Order Task Resource 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 | WorkOrderTaskResource->Version | integer | int32 |\r\n| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| unitOfMeasurementId | WorkOrderTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | WorkOrderTaskResource->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| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| estimatedUsage | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| requiredOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource 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": [ "Work Order Task Resource" ], "summary": "Delete an existing Work Order Task Resource 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 | WorkOrderTaskResource->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": "DeleteWorkOrderTaskResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource 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/WM/WorkOrders/Tasks/Resources": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Get a collection of Work Order Task Resource 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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | WorkOrderTaskResource->Competency_Code | string | |\r\n| competencyDescription | WorkOrderTaskResource->Competency_Description | string | |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costCentreCode | WorkOrderTaskResource->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrderTaskResource->CostCentre_Description | string | |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| costElementCode | WorkOrderTaskResource->CostElement_Code | string | |\r\n| costElementDescription | WorkOrderTaskResource->CostElement_Description | string | |\r\n| taskResourceType | WorkOrderTaskResource->TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | WorkOrderTaskResource->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrderTaskResource->GeneralLedger_Description | string | |\r\n| permissionTreeId | WorkOrderTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResource->PermissionTree_Description | string | |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| notes | WorkOrderTaskResource->Notes | string | |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| isEnabled | WorkOrderTaskResource->IsEnabled | boolean | |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | WorkOrderTaskResource->Resource_Code | string | |\r\n| resourceDescription | WorkOrderTaskResource->Resource_Description | string | |\r\n| resourceContactDetailLastName | WorkOrderTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceContactDetailFirstName | WorkOrderTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceResourceType | WorkOrderTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceSiteCurrencyCode | WorkOrderTaskResource->Resource_Site_Currency_Code | string | |\r\n| resourceTotalCostInResourceCurrency | WorkOrderTaskResource->ResourceTotalCostInResourceCurrency | number | decimal |\r\n| resourceTotalCostInWorkOrderCurrency | WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskResource->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskWorkOrderSiteCurrencyCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_Currency_Code | string | |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderStatusId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskWorkOrderStatusCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Code | string | |\r\n| workOrderTaskWorkOrderStatusDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskResource->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskResource->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskResource->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrderTaskResource->Section_Code | string | |\r\n| sectionDescription | WorkOrderTaskResource->Section_Description | string | |\r\n| sequenceNumber | WorkOrderTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | WorkOrderTaskResource->Trade_Code | string | |\r\n| tradeDescription | WorkOrderTaskResource->Trade_Description | string | |\r\n", "operationId": "GetWorkOrderTaskResourceCollection", "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 Work Order Task Resource collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Task Resource" ], "summary": "Create a new Work Order Task Resource 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| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResource->PermissionTree_Id | integer | int64 |\r\n| notes | WorkOrderTaskResource->Notes | string | |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderTaskResource->SequenceNumber | integer | int32 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| workOrderTaskId | WorkOrderTaskResource->WorkOrderTask_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| estimatedUsage | System Generated | true | If no value specified |\r\n| estimatedUsage | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| requiredOn | Required | True | |\r\n| requiredOn | Nullable | False | |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTaskResource", "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/CreateWorkOrderTaskResourceResourceActionRequest" } }, { "$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/WM/WorkOrders/{workOrderId}/Tasks/Resources": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Get a collection of Work Order Task Resource resources for the Work Order.", "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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| isEnabled | WorkOrderTaskResource->IsEnabled | boolean | |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | WorkOrderTaskResource->Resource_Code | string | |\r\n| resourceDescription | WorkOrderTaskResource->Resource_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskResource->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskAssetTaskAssetTreePathItems | WorkOrderTaskResource->WorkOrderTask_AssetTaskAsset_TreePathItems | array | array |\r\n| workOrderTaskAssetTaskComponentTreePathItems | WorkOrderTaskResource->WorkOrderTask_AssetTaskComponent_TreePathItems | array | array |\r\n", "operationId": "GetWorkOrderTaskResourceForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Task Resource collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/{workOrderTaskId}/Resources": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Get a collection of Work Order Task Resource resources for the Work Order Task", "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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | WorkOrderTaskResource->Competency_Code | string | |\r\n| competencyDescription | WorkOrderTaskResource->Competency_Description | string | |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costCentreCode | WorkOrderTaskResource->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrderTaskResource->CostCentre_Description | string | |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| costElementCode | WorkOrderTaskResource->CostElement_Code | string | |\r\n| costElementDescription | WorkOrderTaskResource->CostElement_Description | string | |\r\n| taskResourceType | WorkOrderTaskResource->TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | WorkOrderTaskResource->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrderTaskResource->GeneralLedger_Description | string | |\r\n| isEnabled | WorkOrderTaskResource->IsEnabled | boolean | |\r\n| permissionTreeId | WorkOrderTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResource->PermissionTree_Description | string | |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| resourceSiteCurrencyCode | WorkOrderTaskResource->Resource_Site_Currency_Code | string | |\r\n| resourceCode | WorkOrderTaskResource->Resource_Code | string | |\r\n| resourceContactDetailLastName | WorkOrderTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceContactDetailFirstName | WorkOrderTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceResourceType | WorkOrderTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceTotalCostInResourceCurrency | WorkOrderTaskResource->ResourceTotalCostInResourceCurrency | number | decimal |\r\n| resourceTotalCostInWorkOrderCurrency | WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency | number | decimal |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrderTaskResource->Section_Code | string | |\r\n| sectionDescription | WorkOrderTaskResource->Section_Description | string | |\r\n| sequenceNumber | WorkOrderTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | WorkOrderTaskResource->Trade_Code | string | |\r\n| tradeDescription | WorkOrderTaskResource->Trade_Description | string | |\r\n| workOrderTaskId | WorkOrderTaskResource->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskResource->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskResource->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskResource->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderSiteCurrencyCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_Currency_Code | string | |\r\n", "operationId": "GetWorkOrderTaskResourceForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Resource collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceChangePermissionTree": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the permission set for changing the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| 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": "LookupWorkOrderTaskResourceChangePermissionTree", "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/WorkOrderTaskResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceCompetency": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the Competency for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Competency->Id | integer | int64 |\r\n| code | Competency->Code | string | |\r\n| description | Competency->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceCompetency", "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 Competency collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceCompetencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceCostCentre": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the Cost Centre for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceCostCentre", "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 Cost Centre collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceCostElement": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the Cost Element for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceGeneralLedger": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the General Ledger for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceGeneralLedger", "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 General Ledger collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceInsertPermissionTree": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the permission set for creating the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| 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": "LookupWorkOrderTaskResourceInsertPermissionTree", "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/WorkOrderTaskResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceResource": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup for the Work Order Task Resource", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| resourceType | Resource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n| costElementId | Resource->CostElement_Id | integer | int64 |\r\n| costElementCode | Resource->CostElement_Code | string | |\r\n| costElementDescription | Resource->CostElement_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceResource", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceSection": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the Section for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceSection", "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 Section collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "LookupWorkOrderTaskResourceTradeFinancialRateUnitOfMeasurement", "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/RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceTrade": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the Trade for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceTrade", "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 Trade collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceUnitOfMeasurement": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "LookupWorkOrderTaskResourceUnitOfMeasurement", "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/WorkOrderTaskResourceUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceWorkOrderTask": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Lookup the Work Order Task for the Work Order Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTask->Id | integer | int64 |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| workOrderRequiredBy | WorkOrderTask->WorkOrder_RequiredBy | string | date-time |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n", "operationId": "LookupWorkOrderTaskResourceWorkOrderTask", "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 Work Order Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceWorkOrderTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Batch/{ids}": { "get": { "tags": [ "Work Order Task Resource" ], "summary": "Get a collection of Work Order Task Resource 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 | WorkOrderTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskResource->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResource->PermissionTree_Description | string | |\r\n| disabledReasons | WorkOrderTaskResource->DisabledReasons | array | enum |\r\n| id | WorkOrderTaskResource->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskResource->IsEnabled | boolean | |\r\n| workOrderTaskId | WorkOrderTaskResource->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskResource->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskResource->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskResource->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderStatusId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskWorkOrderStatusBaseStatus | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | WorkOrderTaskResource->Competency_Code | string | |\r\n| competencyDescription | WorkOrderTaskResource->Competency_Description | string | |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | WorkOrderTaskResource->CostCentre_Description | string | |\r\n| costCentreCode | WorkOrderTaskResource->CostCentre_Code | string | |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| costElementDescription | WorkOrderTaskResource->CostElement_Description | string | |\r\n| costElementCode | WorkOrderTaskResource->CostElement_Code | string | |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | WorkOrderTaskResource->GeneralLedger_Description | string | |\r\n| generalLedgerCode | WorkOrderTaskResource->GeneralLedger_Code | string | |\r\n| notes | WorkOrderTaskResource->Notes | string | |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | WorkOrderTaskResource->Resource_Code | string | |\r\n| resourceDescription | WorkOrderTaskResource->Resource_Description | string | |\r\n| resourceTotalCostInResourceCurrency | WorkOrderTaskResource->ResourceTotalCostInResourceCurrency | number | decimal |\r\n| resourceTotalCostInWorkOrderCurrency | WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency | number | decimal |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | WorkOrderTaskResource->Section_Code | string | |\r\n| sectionDescription | WorkOrderTaskResource->Section_Description | string | |\r\n| sequenceNumber | WorkOrderTaskResource->SequenceNumber | integer | int32 |\r\n| taskResourceId | WorkOrderTaskResource->TaskResourceId | integer | int64 |\r\n| taskResourceType | WorkOrderTaskResource->TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| tradeDescription | WorkOrderTaskResource->Trade_Description | string | |\r\n| tradeCode | WorkOrderTaskResource->Trade_Code | string | |\r\n| unitOfMeasurementId | WorkOrderTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | WorkOrderTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "BatchGetWorkOrderTaskResource", "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 Work Order Task Resource 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 Work Order Task Resource collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Batch": { "post": { "tags": [ "Work Order Task Resource" ], "summary": "Create a new collection of Work Order Task Resource 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| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| notes | WorkOrderTaskResource->Notes | string | |\r\n| permissionTreeId | WorkOrderTaskResource->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkOrderTaskResource->SequenceNumber | integer | int32 |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| workOrderTaskId | WorkOrderTaskResource->WorkOrderTask_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| estimatedUsage | System Generated | true | If no value specified |\r\n| estimatedUsage | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| requiredOn | Required | True | |\r\n| requiredOn | Nullable | False | |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderTaskResource", "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/BatchCreateWorkOrderTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task Resource 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": [ "Work Order Task Resource" ], "summary": "Update a collection of existing Work Order Task Resource 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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| competencyId | WorkOrderTaskResource->Competency_Id | integer | int64 |\r\n| costCentreId | WorkOrderTaskResource->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskResource->CostElement_Id | integer | int64 |\r\n| estimatedUsage | WorkOrderTaskResource->EstimatedUsage | object | composite |\r\n| generalLedgerId | WorkOrderTaskResource->GeneralLedger_Id | integer | int64 |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTaskResource->Trade_Id | integer | int64 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| proficiency | WorkOrderTaskResource->Proficiency | integer | int32 |\r\n| unitOfMeasurementId | WorkOrderTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | WorkOrderTaskResource->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| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| estimatedUsage | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| requiredOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskResource", "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/BatchUpdateWorkOrderTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource 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": [ "Work Order Task Resource" ], "summary": "Delete a collection of existing Work Order Task Resource 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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->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": "BatchDeleteWorkOrderTaskResource", "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/BatchDeleteWorkOrderTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource 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/WM/WorkOrders/Tasks/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task Resource" ], "summary": "Change the PermissionTree for an existing Work Order Task Resource 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 | WorkOrderTaskResource->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResource->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": "ChangeWorkOrderTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task Resource" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task Resource 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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResource->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": "BatchChangeWorkOrderTaskResourcePermissionTree", "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/BatchChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Resources/MatchBatch": { "patch": { "tags": [ "Work Order Task Resource" ], "summary": "Update a collection of existing Work Order Task Resource 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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| version | WorkOrderTaskResource->Version | integer | int32 |\r\n| requiredOn | WorkOrderTaskResource->RequiredOn | string | date-time |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| sectionId | WorkOrderTaskResource->Section_Id | integer | int64 |\r\n| tradeId | WorkOrderTaskResource->Trade_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| requiredOn | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateWorkOrderTaskResource", "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/MatchUpdateWorkOrderTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource 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/WM/WorkOrders/Tasks/Resources/Movements/{id}": { "get": { "tags": [ "Work Order Task Resource Movement" ], "summary": "Get a Work Order Task Resource Movement 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 | WorkOrderTaskResourceMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskResourceMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskResourceMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskResourceMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskResourceMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResourceMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResourceMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskResourceMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskResourceMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskResourceMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskResourceMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskResourceMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskResourceMovement->WorkOrder_Code | string | |\r\n| workOrderTaskMovementId | WorkOrderTaskResourceMovement->WorkOrderTaskMovement_Id | integer | int64 |\r\n| workOrderTaskResourceId | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceId | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code | string | |\r\n", "operationId": "GetWorkOrderTaskResourceMovement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Movement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Resource Movement", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceMovementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Movements": { "get": { "tags": [ "Work Order Task Resource Movement" ], "summary": "Get a collection of Work Order Task Resource Movement 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 | WorkOrderTaskResourceMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskResourceMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResourceMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskResourceMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskResourceMovement->WorkOrder_Description | string | |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code | string | |\r\n| action | WorkOrderTaskResourceMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskResourceMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskResourceMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskResourceMovementCollection", "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 Work Order Task Resource Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Movements/{workOrderTaskMovementId}/Resources": { "get": { "tags": [ "Work Order Task Resource Movement" ], "summary": "Get a collection of Work Order Task Resource Movement resources for the Work Order Task Movement.", "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 | WorkOrderTaskResourceMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskResourceMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResourceMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskResourceMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskResourceMovement->WorkOrder_Description | string | |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code | string | |\r\n| action | WorkOrderTaskResourceMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskResourceMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskResourceMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskResourceMovementForWorkOrderTaskMovementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskMovementId", "in": "path", "required": true, "description": "Work Order Task Movement 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 Work Order Task Resource Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceMovementForWorkOrderTaskMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Movements/Batch/{ids}": { "get": { "tags": [ "Work Order Task Resource Movement" ], "summary": "Get a collection of Work Order Task Resource Movement 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 | WorkOrderTaskResourceMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskResourceMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskResourceMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskResourceMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskResourceMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResourceMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResourceMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskResourceMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskResourceMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskResourceMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskResourceMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskResourceMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskResourceMovement->WorkOrder_Code | string | |\r\n| workOrderTaskMovementId | WorkOrderTaskResourceMovement->WorkOrderTaskMovement_Id | integer | int64 |\r\n| workOrderTaskResourceId | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceId | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code | string | |\r\n", "operationId": "BatchGetWorkOrderTaskResourceMovement", "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 Work Order Task Resource Movement 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 Work Order Task Resource Movement collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskResourceMovementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/{id}": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Get a Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskResourceUsage->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskResourceUsage->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskResourceUsage->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskResourceUsage->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskResourceUsage->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskResourceUsage->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskResourceUsage->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResourceUsage->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResourceUsage->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResourceUsage->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| costInResourceCurrency | WorkOrderTaskResourceUsage->CostInResourceCurrency | number | decimal |\r\n| costInResourceRateCurrency | WorkOrderTaskResourceUsage->CostInResourceRateCurrency | number | decimal |\r\n| costInWorkOrderCurrency | WorkOrderTaskResourceUsage->CostInWorkOrderCurrency | number | decimal |\r\n| financialRateId | WorkOrderTaskResourceUsage->FinancialRateId | integer | int64 |\r\n| financialRateAmount | WorkOrderTaskResourceUsage->FinancialRateAmount | number | decimal |\r\n| financialRateCurrencyId | WorkOrderTaskResourceUsage->FinancialRateCurrency_Id | integer | int64 |\r\n| financialRateCurrencyCode | WorkOrderTaskResourceUsage->FinancialRateCurrency_Code | string | |\r\n| financialRateCurrencyDescription | WorkOrderTaskResourceUsage->FinancialRateCurrency_Description | string | |\r\n| financialRateDescription | WorkOrderTaskResourceUsage->FinancialRateDescription | string | |\r\n| financialRateUnitOfMeasurementId | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Id | integer | int64 |\r\n| financialRateUnitOfMeasurementCode | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Code | string | |\r\n| financialRateUnitOfMeasurementDescription | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Description | string | |\r\n| financialRateUnitOfMeasurementMeasurementType | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| financialRateUnitOfMeasurementMeasurementTypeQuantity | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_MeasurementTypeQuantity | integer | int32 |\r\n| financialYearPeriodId | WorkOrderTaskResourceUsage->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | WorkOrderTaskResourceUsage->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | WorkOrderTaskResourceUsage->FinancialYearPeriod_Description | string | |\r\n| notes | WorkOrderTaskResourceUsage->Notes | string | |\r\n| resourceCurrencyId | WorkOrderTaskResourceUsage->ResourceCurrency_Id | integer | int64 |\r\n| resourceCurrencyCode | WorkOrderTaskResourceUsage->ResourceCurrency_Code | string | |\r\n| resourceCurrencyDescription | WorkOrderTaskResourceUsage->ResourceCurrency_Description | string | |\r\n| resourceRateToResourceCurrencyRateId | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_Id | integer | int64 |\r\n| resourceRateToResourceCurrencyRateAppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_AppliedConversionRate | number | decimal |\r\n| resourceRateToResourceCurrencyRateUserSuppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| resourceRateToResourceCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRateValue | number | decimal |\r\n| resourceRateToWorkOrderCurrencyRateId | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| resourceRateToWorkOrderCurrencyRateAppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_AppliedConversionRate | number | decimal |\r\n| resourceRateToWorkOrderCurrencyRateUserSuppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| resourceRateToWorkOrderCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue | number | decimal |\r\n| resourceTradeFinancialRateId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_Id | integer | int64 |\r\n| resourceTradeFinancialRateFinancialRateId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateId | integer | int64 |\r\n| resourceTradeFinancialRateFinancialRateCurrencyId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Id | integer | int64 |\r\n| resourceTradeFinancialRateFinancialRateCurrencyCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Code | string | |\r\n| resourceTradeFinancialRateFinancialRateCurrencyDescription | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Description | string | |\r\n| resourceTradeFinancialRateResourceTradeId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Id | integer | int64 |\r\n| resourceTradeFinancialRateResourceTradeResourceId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Id | integer | int64 |\r\n| resourceTradeFinancialRateResourceTradeResourceCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Code | string | |\r\n| resourceTradeFinancialRateResourceTradeTradeId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Id | integer | int64 |\r\n| resourceTradeFinancialRateResourceTradeTradeCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Code | string | |\r\n| resourceTradeFinancialRateResourceTradeTradeDescription | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Description | string | |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| workOrderCurrencyId | WorkOrderTaskResourceUsage->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskResourceUsage->WorkOrderCurrency_Code | string | |\r\n| workOrderTaskResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceTaskResourceType | WorkOrderTaskResourceUsage->WorkOrderTaskResource_TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| workOrderTaskResourceResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Description | string | |\r\n| workOrderTaskResourceWorkOrderTaskId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskTaskId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskId | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskTaskCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskResourceWorkOrderTaskTaskDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderTaskResourceUsage", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Usage Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Resource Usage", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceUsageResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Update an existing Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| financialYearPeriodId | WorkOrderTaskResourceUsage->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | WorkOrderTaskResourceUsage->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| completedOn | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskResourceUsage", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Usage Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskResourceUsageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource Usage 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": [ "Work Order Task Resource Usage" ], "summary": "Delete an existing Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->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": "DeleteWorkOrderTaskResourceUsage", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Usage Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskResourceUsageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource Usage 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/WM/WorkOrders/Tasks/Resources/Usages/{workOrderTaskResourceUsageId}/Costing": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Get a collection of Costing resources for the Work Order Task Resource Usage.", "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 | Costing->Id | integer | int64 |\r\n| description | Costing->Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n| workOrderTaskResourceResourceCode | Costing->WorkOrderTaskResource_Resource_Code | string | |\r\n", "operationId": "GetCostingForWorkOrderTaskResourceUsageCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskResourceUsageId", "in": "path", "required": true, "description": "Work Order Task Resource Usage 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 Work Order Task Resource Usage collection", "schema": { "$ref": "#/definitions/GetCostingCollectionForWorkOrderTaskResourceUsageResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Get a collection of Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| financialYearPeriodCode | WorkOrderTaskResourceUsage->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | WorkOrderTaskResourceUsage->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodStartDate | WorkOrderTaskResourceUsage->FinancialYearPeriod_StartDate | string | date |\r\n| financialYearPeriodEndDate | WorkOrderTaskResourceUsage->FinancialYearPeriod_EndDate | string | date |\r\n| financialRateAmount | WorkOrderTaskResourceUsage->FinancialRateAmount | number | decimal |\r\n| financialRateCurrencyCode | WorkOrderTaskResourceUsage->FinancialRateCurrency_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderStatusId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderStatusCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Status_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderStatusDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Status_Description | string | |\r\n| workOrderTaskResourceWorkOrderTaskTaskCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskResourceWorkOrderTaskTaskDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskResourceResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceContactDetailFirstName | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailFirstName | string | |\r\n| workOrderTaskResourceResourceContactDetailLastName | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailLastName | string | |\r\n| workOrderTaskResourceTaskResourceType | WorkOrderTaskResourceUsage->WorkOrderTaskResource_TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| resourceRateToWorkOrderCurrencyRateId | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| resourceRateToWorkOrderCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue | number | decimal |\r\n| workOrderCurrencyId | WorkOrderTaskResourceUsage->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskResourceUsage->WorkOrderCurrency_Code | string | |\r\n| workOrderCurrencyDescription | WorkOrderTaskResourceUsage->WorkOrderCurrency_Description | string | |\r\n| resourceTradeFinancialRateResourceTradeResourceCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Code | string | |\r\n| resourceTradeFinancialRateResourceTradeTradeCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Code | string | |\r\n| resourceTradeFinancialRateResourceTradeTradeDescription | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Description | string | |\r\n| resourceTradeFinancialRateFinancialRateDescription | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateDescription | string | |\r\n", "operationId": "GetWorkOrderTaskResourceUsageCollection", "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 Work Order Task Resource Usage collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceUsageCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Create a new Work Order Task Resource Usage 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| workOrderTaskResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Id | integer | int64 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| financialYearPeriodId | WorkOrderTaskResourceUsage->FinancialYearPeriod_Id | integer | int64 |\r\n| resourceRateToWorkOrderCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue | number | decimal |\r\n| resourceTradeFinancialRateId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskResourceUsage->PermissionTree_Id | integer | int64 |\r\n| notes | WorkOrderTaskResourceUsage->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| workOrderTaskResourceId | Required | True | |\r\n| workOrderTaskResourceId | Nullable | False | |\r\n| completedOn | Nullable | False | |\r\n| usage | Required | True | |\r\n| usage | Nullable | False | |\r\n| resourceRateToWorkOrderCurrencyRateValue | Nullable | False | |\r\n| resourceTradeFinancialRateId | Required | True | |\r\n| resourceTradeFinancialRateId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTaskResourceUsage", "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/CreateWorkOrderTaskResourceUsageResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Resources/{workOrderTaskResourceId}/Usages": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Get a collection of Work Order Task Resource Usage resources for the Work Order Task Resource", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| financialRateAmount | WorkOrderTaskResourceUsage->FinancialRateAmount | number | decimal |\r\n| financialRateCurrencyCode | WorkOrderTaskResourceUsage->FinancialRateCurrency_Code | string | |\r\n| financialRateDescription | WorkOrderTaskResourceUsage->FinancialRateDescription | string | |\r\n| costInResourceRateCurrency | WorkOrderTaskResourceUsage->CostInResourceRateCurrency | number | decimal |\r\n| costInWorkOrderCurrency | WorkOrderTaskResourceUsage->CostInWorkOrderCurrency | number | decimal |\r\n| workOrderCurrencyCode | WorkOrderTaskResourceUsage->WorkOrderCurrency_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskResourceWorkOrderTaskTaskCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskResourceWorkOrderTaskTaskDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskResourceResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceContactDetailFirstName | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailFirstName | string | |\r\n| workOrderTaskResourceResourceContactDetailLastName | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailLastName | string | |\r\n| workOrderTaskResourceResourceResourceType | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n", "operationId": "GetWorkOrderTaskResourceUsageForWorkOrderTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskResourceId", "in": "path", "required": true, "description": "Work Order Task Resource 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 Work Order Task Resource Usage collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskResourceUsageForWorkOrderTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Lookups/LookupWorkOrderTaskResourceUsageChangePermissionTree": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Lookup the permission set for changing the Work Order Task Resource Usage.", "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": "LookupWorkOrderTaskResourceUsageChangePermissionTree", "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/WorkOrderTaskResourceDurationChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Lookups/LookupWorkOrderTaskResourceUsageInsertPermissionTree": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Lookup the permission set for creating the Work Order Task Resource Usage.", "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": "LookupWorkOrderTaskResourceUsageInsertPermissionTree", "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/WorkOrderTaskResourceDurationInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Lookups/LookupWorkOrderTaskResourceRate": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Lookup the Resource Trade Financial Rate for the Work Order Task Resource Usage.", "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 | ResourceTradeFinancialRate->Id | integer | int64 |\r\n| resourceTradeResourceCode | ResourceTradeFinancialRate->ResourceTrade_Resource_Code | string | |\r\n| resourceTradeTradeId | ResourceTradeFinancialRate->ResourceTrade_Trade_Id | integer | int64 |\r\n| resourceTradeTradeCode | ResourceTradeFinancialRate->ResourceTrade_Trade_Code | string | |\r\n| resourceTradeTradeDescription | ResourceTradeFinancialRate->ResourceTrade_Trade_Description | string | |\r\n| financialRateDescription | ResourceTradeFinancialRate->FinancialRateDescription | string | |\r\n| financialRateCurrencyId | ResourceTradeFinancialRate->FinancialRateCurrency_Id | integer | int64 |\r\n| financialRateCurrencyCode | ResourceTradeFinancialRate->FinancialRateCurrency_Code | string | |\r\n| financialRateAmount | ResourceTradeFinancialRate->FinancialRateAmount | number | decimal |\r\n| financialRateUnitOfMeasurementId | ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id | integer | int64 |\r\n| financialRateUnitOfMeasurementCode | ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code | string | |\r\n| financialRateUnitOfMeasurementDescription | ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Description | string | |\r\n| financialRateUnitOfMeasurementMeasurementType | ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "LookupWorkOrderTaskResourceRate", "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 Resource Trade Financial Rate collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceDurationResourceRateLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Lookups/LookupWorkOrderTaskResourceUsageWorkOrderTaskResource": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Lookup the Work Order Task Resource for the Work Order Task Resource Usage.", "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 | WorkOrderTaskResource->Id | integer | int64 |\r\n| taskResourceType | WorkOrderTaskResource->TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderSiteFinancialYearPeriodId | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_FinancialYearPeriod_Id | integer | int64 |\r\n| workOrderTaskWorkOrderSiteFinancialYearPeriodCode | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_FinancialYearPeriod_Code | string | |\r\n| workOrderTaskWorkOrderSiteFinancialYearPeriodDescription | WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_FinancialYearPeriod_Description | string | |\r\n| workOrderTaskTaskId | WorkOrderTaskResource->WorkOrderTask_TaskId | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskResource->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskResource->WorkOrderTask_TaskDescription | string | |\r\n| resourceId | WorkOrderTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | WorkOrderTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | WorkOrderTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | WorkOrderTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceResourceType | WorkOrderTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n", "operationId": "LookupWorkOrderTaskResourceUsageWorkOrderTaskResource", "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 Work Order Task Resource collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceDurationWorkOrderTaskResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Lookups/LookupWorkOrderTaskResourceUsageFinancialYearPeriod": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Lookup the Financial Year Period for the Work Order Task Resource Usage.", "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 | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskResourceUsageFinancialYearPeriod", "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 Financial Year Period collection", "schema": { "$ref": "#/definitions/WorkOrderTaskResourceUsageFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Lookups/LookupWorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Lookup the Unit Of Measurement for the Work Order Task Resource Usage.", "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": "LookupWorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurement", "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/WorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Batch/{ids}": { "get": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Get a collection of Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskResourceUsage->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskResourceUsage->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskResourceUsage->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskResourceUsage->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskResourceUsage->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskResourceUsage->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskResourceUsage->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResourceUsage->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskResourceUsage->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskResourceUsage->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| costInResourceCurrency | WorkOrderTaskResourceUsage->CostInResourceCurrency | number | decimal |\r\n| costInResourceRateCurrency | WorkOrderTaskResourceUsage->CostInResourceRateCurrency | number | decimal |\r\n| costInWorkOrderCurrency | WorkOrderTaskResourceUsage->CostInWorkOrderCurrency | number | decimal |\r\n| financialRateId | WorkOrderTaskResourceUsage->FinancialRateId | integer | int64 |\r\n| financialRateAmount | WorkOrderTaskResourceUsage->FinancialRateAmount | number | decimal |\r\n| financialRateCurrencyId | WorkOrderTaskResourceUsage->FinancialRateCurrency_Id | integer | int64 |\r\n| financialRateCurrencyCode | WorkOrderTaskResourceUsage->FinancialRateCurrency_Code | string | |\r\n| financialRateCurrencyDescription | WorkOrderTaskResourceUsage->FinancialRateCurrency_Description | string | |\r\n| financialRateDescription | WorkOrderTaskResourceUsage->FinancialRateDescription | string | |\r\n| financialRateUnitOfMeasurementId | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Id | integer | int64 |\r\n| financialRateUnitOfMeasurementCode | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Code | string | |\r\n| financialRateUnitOfMeasurementDescription | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Description | string | |\r\n| financialRateUnitOfMeasurementMeasurementType | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| financialRateUnitOfMeasurementMeasurementTypeQuantity | WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_MeasurementTypeQuantity | integer | int32 |\r\n| financialYearPeriodId | WorkOrderTaskResourceUsage->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | WorkOrderTaskResourceUsage->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | WorkOrderTaskResourceUsage->FinancialYearPeriod_Description | string | |\r\n| notes | WorkOrderTaskResourceUsage->Notes | string | |\r\n| resourceCurrencyId | WorkOrderTaskResourceUsage->ResourceCurrency_Id | integer | int64 |\r\n| resourceCurrencyCode | WorkOrderTaskResourceUsage->ResourceCurrency_Code | string | |\r\n| resourceCurrencyDescription | WorkOrderTaskResourceUsage->ResourceCurrency_Description | string | |\r\n| resourceRateToResourceCurrencyRateId | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_Id | integer | int64 |\r\n| resourceRateToResourceCurrencyRateAppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_AppliedConversionRate | number | decimal |\r\n| resourceRateToResourceCurrencyRateUserSuppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| resourceRateToResourceCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRateValue | number | decimal |\r\n| resourceRateToWorkOrderCurrencyRateId | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| resourceRateToWorkOrderCurrencyRateAppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_AppliedConversionRate | number | decimal |\r\n| resourceRateToWorkOrderCurrencyRateUserSuppliedConversionRate | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| resourceRateToWorkOrderCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue | number | decimal |\r\n| resourceTradeFinancialRateId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_Id | integer | int64 |\r\n| resourceTradeFinancialRateFinancialRateId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateId | integer | int64 |\r\n| resourceTradeFinancialRateFinancialRateCurrencyId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Id | integer | int64 |\r\n| resourceTradeFinancialRateFinancialRateCurrencyCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Code | string | |\r\n| resourceTradeFinancialRateFinancialRateCurrencyDescription | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Description | string | |\r\n| resourceTradeFinancialRateResourceTradeId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Id | integer | int64 |\r\n| resourceTradeFinancialRateResourceTradeResourceId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Id | integer | int64 |\r\n| resourceTradeFinancialRateResourceTradeResourceCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Code | string | |\r\n| resourceTradeFinancialRateResourceTradeTradeId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Id | integer | int64 |\r\n| resourceTradeFinancialRateResourceTradeTradeCode | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Code | string | |\r\n| resourceTradeFinancialRateResourceTradeTradeDescription | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Description | string | |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| workOrderCurrencyId | WorkOrderTaskResourceUsage->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskResourceUsage->WorkOrderCurrency_Code | string | |\r\n| workOrderTaskResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Id | integer | int64 |\r\n| workOrderTaskResourceTaskResourceType | WorkOrderTaskResourceUsage->WorkOrderTaskResource_TaskResourceType | string (Allowed values: [RegularAssetTaskResource, StandardTaskResource]) | enum |\r\n| workOrderTaskResourceResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id | integer | int64 |\r\n| workOrderTaskResourceResourceCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code | string | |\r\n| workOrderTaskResourceResourceDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Description | string | |\r\n| workOrderTaskResourceWorkOrderTaskId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskTaskId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskId | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskTaskCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskResourceWorkOrderTaskTaskDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderCode | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskResourceWorkOrderTaskWorkOrderDescription | WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderTaskResourceUsage", "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 Work Order Task Resource Usage 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 Work Order Task Resource Usage collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskResourceUsageResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Resources/Usages/Batch": { "post": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Create a new collection of Work Order Task Resource Usage 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| workOrderTaskResourceId | WorkOrderTaskResourceUsage->WorkOrderTaskResource_Id | integer | int64 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\r\n| financialYearPeriodId | WorkOrderTaskResourceUsage->FinancialYearPeriod_Id | integer | int64 |\r\n| resourceRateToWorkOrderCurrencyRateValue | WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue | number | decimal |\r\n| resourceTradeFinancialRateId | WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskResourceUsage->PermissionTree_Id | integer | int64 |\r\n| notes | WorkOrderTaskResourceUsage->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| workOrderTaskResourceId | Required | True | |\r\n| workOrderTaskResourceId | Nullable | False | |\r\n| completedOn | Nullable | False | |\r\n| usage | Required | True | |\r\n| usage | Nullable | False | |\r\n| resourceRateToWorkOrderCurrencyRateValue | Nullable | False | |\r\n| resourceTradeFinancialRateId | Required | True | |\r\n| resourceTradeFinancialRateId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderTaskResourceUsage", "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/BatchCreateWorkOrderTaskResourceUsageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task Resource Usage 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": [ "Work Order Task Resource Usage" ], "summary": "Update a collection of existing Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| completedOn | WorkOrderTaskResourceUsage->CompletedOn | string | date-time |\r\n| financialYearPeriodId | WorkOrderTaskResourceUsage->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | WorkOrderTaskResourceUsage->Notes | string | |\r\n| usage | WorkOrderTaskResourceUsage->Usage | object | composite |\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| completedOn | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskResourceUsage", "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/BatchUpdateWorkOrderTaskResourceUsageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource Usage 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": [ "Work Order Task Resource Usage" ], "summary": "Delete a collection of existing Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceUsage->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": "BatchDeleteWorkOrderTaskResourceUsage", "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/BatchDeleteWorkOrderTaskResourceUsageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Resource Usage 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/WM/WorkOrders/Tasks/Resources/Usages/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Change the PermissionTree for an existing Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResourceUsage->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": "ChangeWorkOrderTaskResourceUsagePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Resource Usage Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Resources/Usages/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task Resource Usage" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task Resource Usage 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 | WorkOrderTaskResourceUsage->Id | integer | int64 |\r\n| version | WorkOrderTaskResourceUsage->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskResourceUsage->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": "BatchChangeWorkOrderTaskResourceUsagePermissionTree", "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/BatchChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/{id}": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Get a Work Order Task Spare 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 | WorkOrderTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskSpare->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpare->PermissionTree_Description | string | |\r\n| disabledReasons | WorkOrderTaskSpare->DisabledReasons | array | enum |\r\n| id | WorkOrderTaskSpare->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskSpare->IsEnabled | boolean | |\r\n| workOrderTaskId | WorkOrderTaskSpare->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskSpare->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskSpare->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSpare->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Description | string | |\r\n| code | WorkOrderTaskSpare->Code | string | |\r\n| costCentreId | WorkOrderTaskSpare->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | WorkOrderTaskSpare->CostCentre_Description | string | |\r\n| costCentreCode | WorkOrderTaskSpare->CostCentre_Code | string | |\r\n| costElementId | WorkOrderTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementDescription | WorkOrderTaskSpare->CostElement_Description | string | |\r\n| costElementCode | WorkOrderTaskSpare->CostElement_Code | string | |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| financialYearPeriodId | WorkOrderTaskSpare->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodDescription | WorkOrderTaskSpare->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodCode | WorkOrderTaskSpare->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | WorkOrderTaskSpare->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | WorkOrderTaskSpare->GeneralLedger_Description | string | |\r\n| generalLedgerCode | WorkOrderTaskSpare->GeneralLedger_Code | string | |\r\n| hasRequisition | WorkOrderTaskSpare->HasRequisition | boolean | |\r\n| notes | WorkOrderTaskSpare->Notes | string | |\r\n| quantityApprovedOnRequisitions | WorkOrderTaskSpare->QuantityApprovedOnRequisitions | number | decimal |\r\n| quantityOnRequisitions | WorkOrderTaskSpare->QuantityOnRequisitions | number | decimal |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| spareCurrencyId | WorkOrderTaskSpare->SpareCurrency_Id | integer | int64 |\r\n| spareCurrencyCode | WorkOrderTaskSpare->SpareCurrency_Code | string | |\r\n| spareCurrencyDescription | WorkOrderTaskSpare->SpareCurrency_Description | string | |\r\n| spareToWorkOrderCurrencyRateId | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| spareToWorkOrderCurrencyRateUserSuppliedConversionRate | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| spareToWorkOrderCurrencyRateValue | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | WorkOrderTaskSpare->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | WorkOrderTaskSpare->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | WorkOrderTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | WorkOrderTaskSpare->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | WorkOrderTaskSpare->StockItem_Warehouse_Code | string | |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| supplierDescription | WorkOrderTaskSpare->Supplier_Description | string | |\r\n| supplierCode | WorkOrderTaskSpare->Supplier_Code | string | |\r\n| taskSpareId | WorkOrderTaskSpare->TaskSpareId | integer | int64 |\r\n| taskSpareType | WorkOrderTaskSpare->TaskSpareType | string (Allowed values: [RegularAssetTaskSpare, StandardTaskSpare]) | enum |\r\n| totalRequiredInSpareCurrency | WorkOrderTaskSpare->TotalRequiredInSpareCurrency | number | decimal |\r\n| totalRequiredInWorkOrderCurrency | WorkOrderTaskSpare->TotalRequiredInWorkOrderCurrency | number | decimal |\r\n| totalUsedInSpareCurrency | WorkOrderTaskSpare->TotalUsedInSpareCurrency | number | decimal |\r\n| totalUsedInWorkOrderCurrency | WorkOrderTaskSpare->TotalUsedInWorkOrderCurrency | number | decimal |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementDescription | WorkOrderTaskSpare->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementCode | WorkOrderTaskSpare->UnitOfMeasurement_Code | string | |\r\n| unitPriceInSpareCurrency | WorkOrderTaskSpare->UnitPriceInSpareCurrency | number | decimal |\r\n| unitPriceInWorkOrderCurrency | WorkOrderTaskSpare->UnitPriceInWorkOrderCurrency | number | decimal |\r\n| workOrderCurrencyId | WorkOrderTaskSpare->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyDescription | WorkOrderTaskSpare->WorkOrderCurrency_Description | string | |\r\n| workOrderCurrencyCode | WorkOrderTaskSpare->WorkOrderCurrency_Code | string | |\r\n", "operationId": "GetWorkOrderTaskSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Spare", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Spare" ], "summary": "Update an existing Work Order Task Spare 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 | WorkOrderTaskSpare->Version | integer | int32 |\r\n| code | WorkOrderTaskSpare->Code | string | |\r\n| costCentreId | WorkOrderTaskSpare->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskSpare->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| generalLedgerId | WorkOrderTaskSpare->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskSpare->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | WorkOrderTaskSpare->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| spareToWorkOrderCurrencyRateId | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | WorkOrderTaskSpare->UnitPriceInSpareCurrency | 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 | Read-only | True | WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem' |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem' |\r\n| generalLedgerId | Nullable | False | |\r\n| quantityRequired | Nullable | False | |\r\n| quantityUsed | Nullable | False | |\r\n| quantityUsed | Min Value | >= 0| |\r\n| spareToWorkOrderCurrencyRateId | Nullable | False | |\r\n| supplierId | Nullable | False | WorkOrderTaskSpare->SpareType NE 'StockItem' |\r\n| unitPriceInSpareCurrency | Nullable | False | |\r\n| unitPriceInSpareCurrency | Read-only | True | WorkOrderTaskSpare->SpareType EQ 'StockItem' |\r\n| unitPriceInSpareCurrency | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateWorkOrderTaskSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare 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": [ "Work Order Task Spare" ], "summary": "Delete an existing Work Order Task Spare 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 | WorkOrderTaskSpare->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": "DeleteWorkOrderTaskSpare", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare 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/WM/WorkOrders/Tasks/Spares/{id}/requisitionItems": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Get a collection of Work Order Task Spare resources for the .", "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 | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| requisitionCode | RequisitionItem->Requisition_Code | string | |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| workOrderTaskSpareCode | RequisitionItem->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareWorkOrderTaskWorkOrderCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskCode | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskSpareWorkOrderTaskTaskDescription | RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskSpareSpareType | RequisitionItem->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareStockItemMaterialMasterId | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemMaterialMasterDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description | string | |\r\n| workOrderTaskSpareStockItemWarehouseCode | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseDescription | RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description | string | |\r\n| workOrderTaskSpareStockItemAverageItemCost | RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost | number | decimal |\r\n| workOrderTaskSpareStockItemQuantityOnHand | RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand | number | decimal |\r\n| workOrderTaskSpareSupplierCode | RequisitionItem->WorkOrderTaskSpare_Supplier_Code | string | |\r\n| workOrderTaskSpareSupplierDescription | RequisitionItem->WorkOrderTaskSpare_Supplier_Description | string | |\r\n| workOrderTaskSpareUnitPriceInSpareCurrency | RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskSpareTotalUsedInWorkOrderCurrency | RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency | number | decimal |\r\n| quantityIssued | RequisitionItem->QuantityIssued | number | decimal |\r\n| quantityNotIssued | RequisitionItem->QuantityNotIssued | number | decimal |\r\n", "operationId": "GetRequisitionItemForWorkOrderTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare 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 Work Order Task Spare collection", "schema": { "$ref": "#/definitions/GetRequisitionItemForWorkOrderTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Get a collection of Work Order Task Spare 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 | WorkOrderTaskSpare->Id | integer | int64 |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n| code | WorkOrderTaskSpare->Code | string | |\r\n| costCentreCode | WorkOrderTaskSpare->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrderTaskSpare->CostCentre_Description | string | |\r\n| costElementCode | WorkOrderTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | WorkOrderTaskSpare->CostElement_Description | string | |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| generalLedgerCode | WorkOrderTaskSpare->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrderTaskSpare->GeneralLedger_Description | string | |\r\n| permissionTreeId | WorkOrderTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpare->PermissionTree_Description | string | |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| isEnabled | WorkOrderTaskSpare->IsEnabled | boolean | |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| spareCurrencyId | WorkOrderTaskSpare->SpareCurrency_Id | integer | int64 |\r\n| spareCurrencyCode | WorkOrderTaskSpare->SpareCurrency_Code | string | |\r\n| spareCurrencyDescription | WorkOrderTaskSpare->SpareCurrency_Description | string | |\r\n| spareToWorkOrderCurrencyRateId | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| spareToWorkOrderCurrencyRateSourceCurrencyCode | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_SourceCurrency_Code | string | |\r\n| spareToWorkOrderCurrencyRateSourceCurrencyDescription | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_SourceCurrency_Description | string | |\r\n| spareToWorkOrderCurrencyRateValue | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | WorkOrderTaskSpare->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterCode | WorkOrderTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | WorkOrderTaskSpare->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseCode | WorkOrderTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | WorkOrderTaskSpare->StockItem_Warehouse_Description | string | |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| supplierCode | WorkOrderTaskSpare->Supplier_Code | string | |\r\n| supplierDescription | WorkOrderTaskSpare->Supplier_Description | string | |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| taskSpareId | WorkOrderTaskSpare->TaskSpareId | integer | int64 |\r\n| taskSpareType | WorkOrderTaskSpare->TaskSpareType | string (Allowed values: [RegularAssetTaskSpare, StandardTaskSpare]) | enum |\r\n| totalRequiredInSpareCurrency | WorkOrderTaskSpare->TotalRequiredInSpareCurrency | number | decimal |\r\n| totalRequiredInWorkOrderCurrency | WorkOrderTaskSpare->TotalRequiredInWorkOrderCurrency | number | decimal |\r\n| totalUsedInSpareCurrency | WorkOrderTaskSpare->TotalUsedInSpareCurrency | number | decimal |\r\n| totalUsedInWorkOrderCurrency | WorkOrderTaskSpare->TotalUsedInWorkOrderCurrency | number | decimal |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskSpare->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskSpare->UnitOfMeasurement_Description | string | |\r\n| workOrderCurrencyId | WorkOrderTaskSpare->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyCode | WorkOrderTaskSpare->WorkOrderCurrency_Code | string | |\r\n| workOrderTaskId | WorkOrderTaskSpare->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderStatusId | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskWorkOrderStatusCode | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Status_Code | string | |\r\n| workOrderTaskWorkOrderStatusDescription | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Status_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskSpare->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskSpare->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSpare->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n", "operationId": "GetWorkOrderTaskSpareCollection", "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 Work Order Task Spare collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Order Task Spare" ], "summary": "Create a new Work Order Task Spare 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 | WorkOrderTaskSpare->Code | string | |\r\n| costCentreId | WorkOrderTaskSpare->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskSpare->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| financialYearPeriodId | WorkOrderTaskSpare->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | WorkOrderTaskSpare->GeneralLedger_Id | integer | int64 |\r\n| notes | WorkOrderTaskSpare->Notes | string | |\r\n| permissionTreeId | WorkOrderTaskSpare->PermissionTree_Id | integer | int64 |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| spareToWorkOrderCurrencyRateValue | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | WorkOrderTaskSpare->UnitPriceInSpareCurrency | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskSpare->WorkOrderTask_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| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantityRequired | Required | True | |\r\n| quantityRequired | Nullable | False | |\r\n| quantityUsed | Nullable | False | |\r\n| quantityUsed | Min Value | >= 0| |\r\n| requiredOn | Required | True | |\r\n| requiredOn | Nullable | False | |\r\n| spareToWorkOrderCurrencyRateValue | System Generated | true | If no value specified |\r\n| spareToWorkOrderCurrencyRateValue | Nullable | False | |\r\n| spareType | Required | True | |\r\n| spareType | Nullable | False | |\r\n| stockItemId | Nullable | True | WorkOrderTaskSpare->SpareType NE 'StockItem' AND WorkOrderTaskSpare->SpareType NE 'CodedNonStockItem' |\r\n| stockItemId | Nullable | False | WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem' |\r\n| supplierId | Nullable | False | WorkOrderTaskSpare->SpareType NE 'StockItem' |\r\n| unitPriceInSpareCurrency | Nullable | False | |\r\n| unitPriceInSpareCurrency | Min Value | >= 0| |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTaskSpare", "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/CreateWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/{workOrderTaskWorkOrderId}/Spares": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Get a collection of Work Order Task Spare resources for the Work Order.", "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 | WorkOrderTaskSpare->Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskSpare->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskAssetTreePathItems | WorkOrderTaskSpare->WorkOrderTask_AssetTreePathItems | array | array |\r\n| workOrderTaskComponentTreePathItems | WorkOrderTaskSpare->WorkOrderTask_ComponentTreePathItems | array | array |\r\n| code | WorkOrderTaskSpare->Code | string | |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| isEnabled | WorkOrderTaskSpare->IsEnabled | boolean | |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | WorkOrderTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | WorkOrderTaskSpare->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseCode | WorkOrderTaskSpare->StockItem_Warehouse_Code | string | |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskSpare->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskSpare->UnitOfMeasurement_Description | string | |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskSpareForWorkOrderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskWorkOrderId", "in": "path", "required": true, "description": "Work Order 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 Work Order Task Spare collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareForWorkOrderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/{workOrderTaskId}/Spares": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Get a collection of Work Order Task Spare resources for the Work Order Task", "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 | WorkOrderTaskSpare->Code | string | |\r\n| costCentreCode | WorkOrderTaskSpare->CostCentre_Code | string | |\r\n| costCentreDescription | WorkOrderTaskSpare->CostCentre_Description | string | |\r\n| costElementCode | WorkOrderTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | WorkOrderTaskSpare->CostElement_Description | string | |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| generalLedgerCode | WorkOrderTaskSpare->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | WorkOrderTaskSpare->GeneralLedger_Description | string | |\r\n| id | WorkOrderTaskSpare->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskSpare->IsEnabled | boolean | |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | WorkOrderTaskSpare->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterCode | WorkOrderTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | WorkOrderTaskSpare->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseCode | WorkOrderTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | WorkOrderTaskSpare->StockItem_Warehouse_Description | string | |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| supplierCode | WorkOrderTaskSpare->Supplier_Code | string | |\r\n| supplierDescription | WorkOrderTaskSpare->Supplier_Description | string | |\r\n| taskSpareType | WorkOrderTaskSpare->TaskSpareType | string (Allowed values: [RegularAssetTaskSpare, StandardTaskSpare]) | enum |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | WorkOrderTaskSpare->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | WorkOrderTaskSpare->UnitOfMeasurement_Description | string | |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskSpareForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Spare collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareAssetStockItem": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Stock Item for the Work Order Task Spare.", "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 | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupWorkOrderTaskSpareAssetStockItem", "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 Stock Item collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareAssetStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareChangePermissionTree": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the permission set for changing the Work Order Task Spare.", "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": "LookupWorkOrderTaskSpareChangePermissionTree", "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/WorkOrderTaskSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareCodedNonStockItemForSite": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Stock Item for the Work Order Task Spare.", "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 | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupWorkOrderTaskSpareCodedNonStockItemForSite", "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 Stock Item collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareCodedNonStockItemForSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareCodedNonStockItem": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Stock Item for the Work Order Task Spare.", "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 | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupWorkOrderTaskSpareCodedNonStockItem", "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 Stock Item collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareCodedNonStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareCostCentre": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Cost Centre for the Work Order Task Spare.", "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 | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskSpareCostCentre", "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 Cost Centre collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareCostElement": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Cost Element for the Work Order Task Spare.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskSpareCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareFinancialYearPeriod": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Financial Year Period for the Work Order Task Spare.", "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 | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskSpareFinancialYearPeriod", "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 Financial Year Period collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareGeneralLedger": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the General Ledger for the Work Order Task Spare.", "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 | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupWorkOrderTaskSpareGeneralLedger", "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 General Ledger collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareInsertPermissionTree": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the permission set for creating the Work Order Task Spare.", "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": "LookupWorkOrderTaskSpareInsertPermissionTree", "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/WorkOrderTaskSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareResourceContact": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Resource for the Work Order Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupWorkOrderTaskSpareResourceContact", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareRequesterContactLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareSpareCurrency": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Currency for the Work Order Task Spare.", "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": "LookupWorkOrderTaskSpareSpareCurrency", "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/WorkOrderTaskSpareSpareCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareStockItemForSiteWarehouse": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Stock Item for the Work Order Task Spare.", "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 | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupWorkOrderTaskSpareStockItemForSiteWarehouse", "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 Stock Item collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareStockItemForSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareStockItem": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Stock Item for the Work Order Task Spare.", "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 | StockItem->Id | integer | int64 |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| defaultStockItemSupplierSupplierId | StockItem->DefaultStockItemSupplier_Supplier_Id | integer | int64 |\r\n| defaultStockItemSupplierSupplierCode | StockItem->DefaultStockItemSupplier_Supplier_Code | string | |\r\n| defaultStockItemSupplierSupplierDescription | StockItem->DefaultStockItemSupplier_Supplier_Description | string | |\r\n| unitOfMeasurementId | StockItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StockItem->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StockItem->UnitOfMeasurement_Description | string | |\r\n| averageItemCost | StockItem->AverageItemCost | number | decimal |\r\n| quantityOnHand | StockItem->QuantityOnHand | number | decimal |\r\n", "operationId": "LookupWorkOrderTaskSpareStockItem", "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 Stock Item collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareSupplier": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Supplier for the Work Order Task Spare.", "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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| currencyCode | Supplier->Currency_Code | string | |\r\n| currencyDescription | Supplier->Currency_Description | string | |\r\n", "operationId": "LookupWorkOrderTaskSpareSupplier", "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 Supplier collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareUnitOfMeasurement": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Unit Of Measurement for the Work Order Task Spare.", "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": "LookupWorkOrderTaskSpareUnitOfMeasurement", "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/WorkOrderTaskSpareUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareWorkOrderCurrency": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Currency for the Work Order Task Spare.", "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": "LookupWorkOrderTaskSpareWorkOrderCurrency", "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/WorkOrderTaskSpareWorkOrderCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareWorkOrderTask": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Lookup the Work Order Task for the Work Order Task Spare.", "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 | WorkOrderTask->Id | integer | int64 |\r\n| workOrderId | WorkOrderTask->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTask->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTask->WorkOrder_Description | string | |\r\n| workOrderRequiredBy | WorkOrderTask->WorkOrder_RequiredBy | string | date-time |\r\n| taskCode | WorkOrderTask->TaskCode | string | |\r\n| taskDescription | WorkOrderTask->TaskDescription | string | |\r\n| taskType | WorkOrderTask->TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n", "operationId": "LookupWorkOrderTaskSpareWorkOrderTask", "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 Work Order Task collection", "schema": { "$ref": "#/definitions/WorkOrderTaskSpareWorkOrderTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Batch/{ids}": { "get": { "tags": [ "Work Order Task Spare" ], "summary": "Get a collection of Work Order Task Spare 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 | WorkOrderTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskSpare->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpare->PermissionTree_Description | string | |\r\n| disabledReasons | WorkOrderTaskSpare->DisabledReasons | array | enum |\r\n| id | WorkOrderTaskSpare->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskSpare->IsEnabled | boolean | |\r\n| workOrderTaskId | WorkOrderTaskSpare->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskSpare->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskSpare->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSpare->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Description | string | |\r\n| code | WorkOrderTaskSpare->Code | string | |\r\n| costCentreId | WorkOrderTaskSpare->CostCentre_Id | integer | int64 |\r\n| costCentreDescription | WorkOrderTaskSpare->CostCentre_Description | string | |\r\n| costCentreCode | WorkOrderTaskSpare->CostCentre_Code | string | |\r\n| costElementId | WorkOrderTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementDescription | WorkOrderTaskSpare->CostElement_Description | string | |\r\n| costElementCode | WorkOrderTaskSpare->CostElement_Code | string | |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| financialYearPeriodId | WorkOrderTaskSpare->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodDescription | WorkOrderTaskSpare->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodCode | WorkOrderTaskSpare->FinancialYearPeriod_Code | string | |\r\n| generalLedgerId | WorkOrderTaskSpare->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerDescription | WorkOrderTaskSpare->GeneralLedger_Description | string | |\r\n| generalLedgerCode | WorkOrderTaskSpare->GeneralLedger_Code | string | |\r\n| hasRequisition | WorkOrderTaskSpare->HasRequisition | boolean | |\r\n| notes | WorkOrderTaskSpare->Notes | string | |\r\n| quantityApprovedOnRequisitions | WorkOrderTaskSpare->QuantityApprovedOnRequisitions | number | decimal |\r\n| quantityOnRequisitions | WorkOrderTaskSpare->QuantityOnRequisitions | number | decimal |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| spareCurrencyId | WorkOrderTaskSpare->SpareCurrency_Id | integer | int64 |\r\n| spareCurrencyCode | WorkOrderTaskSpare->SpareCurrency_Code | string | |\r\n| spareCurrencyDescription | WorkOrderTaskSpare->SpareCurrency_Description | string | |\r\n| spareToWorkOrderCurrencyRateId | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| spareToWorkOrderCurrencyRateUserSuppliedConversionRate | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| spareToWorkOrderCurrencyRateValue | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | WorkOrderTaskSpare->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | WorkOrderTaskSpare->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | WorkOrderTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | WorkOrderTaskSpare->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | WorkOrderTaskSpare->StockItem_Warehouse_Code | string | |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| supplierDescription | WorkOrderTaskSpare->Supplier_Description | string | |\r\n| supplierCode | WorkOrderTaskSpare->Supplier_Code | string | |\r\n| taskSpareId | WorkOrderTaskSpare->TaskSpareId | integer | int64 |\r\n| taskSpareType | WorkOrderTaskSpare->TaskSpareType | string (Allowed values: [RegularAssetTaskSpare, StandardTaskSpare]) | enum |\r\n| totalRequiredInSpareCurrency | WorkOrderTaskSpare->TotalRequiredInSpareCurrency | number | decimal |\r\n| totalRequiredInWorkOrderCurrency | WorkOrderTaskSpare->TotalRequiredInWorkOrderCurrency | number | decimal |\r\n| totalUsedInSpareCurrency | WorkOrderTaskSpare->TotalUsedInSpareCurrency | number | decimal |\r\n| totalUsedInWorkOrderCurrency | WorkOrderTaskSpare->TotalUsedInWorkOrderCurrency | number | decimal |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementDescription | WorkOrderTaskSpare->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementCode | WorkOrderTaskSpare->UnitOfMeasurement_Code | string | |\r\n| unitPriceInSpareCurrency | WorkOrderTaskSpare->UnitPriceInSpareCurrency | number | decimal |\r\n| unitPriceInWorkOrderCurrency | WorkOrderTaskSpare->UnitPriceInWorkOrderCurrency | number | decimal |\r\n| workOrderCurrencyId | WorkOrderTaskSpare->WorkOrderCurrency_Id | integer | int64 |\r\n| workOrderCurrencyDescription | WorkOrderTaskSpare->WorkOrderCurrency_Description | string | |\r\n| workOrderCurrencyCode | WorkOrderTaskSpare->WorkOrderCurrency_Code | string | |\r\n", "operationId": "BatchGetWorkOrderTaskSpare", "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 Work Order Task Spare 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 Work Order Task Spare collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Batch": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Create a new collection of Work Order Task Spare 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 | WorkOrderTaskSpare->Code | string | |\r\n| costCentreId | WorkOrderTaskSpare->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskSpare->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| generalLedgerId | WorkOrderTaskSpare->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskSpare->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | WorkOrderTaskSpare->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskSpare->PermissionTree_Id | integer | int64 |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| workOrderTaskId | WorkOrderTaskSpare->WorkOrderTask_Id | integer | int64 |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| spareType | WorkOrderTaskSpare->SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| spareToWorkOrderCurrencyRateValue | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| stockItemId | WorkOrderTaskSpare->StockItem_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | WorkOrderTaskSpare->UnitPriceInSpareCurrency | 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| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantityUsed | Nullable | False | |\r\n| quantityUsed | Min Value | >= 0| |\r\n| quantityRequired | Required | True | |\r\n| quantityRequired | Nullable | False | |\r\n| workOrderTaskId | Required | True | |\r\n| workOrderTaskId | Nullable | False | |\r\n| requiredOn | Required | True | |\r\n| requiredOn | Nullable | False | |\r\n| spareType | Required | True | |\r\n| spareType | Nullable | False | |\r\n| spareToWorkOrderCurrencyRateValue | System Generated | true | If no value specified |\r\n| spareToWorkOrderCurrencyRateValue | Nullable | False | |\r\n| stockItemId | Nullable | True | WorkOrderTaskSpare->SpareType NE 'StockItem' AND WorkOrderTaskSpare->SpareType NE 'CodedNonStockItem' |\r\n| stockItemId | Nullable | False | WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem' |\r\n| supplierId | Nullable | False | WorkOrderTaskSpare->SpareType NE 'StockItem' |\r\n| unitPriceInSpareCurrency | Nullable | False | |\r\n| unitPriceInSpareCurrency | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateWorkOrderTaskSpare", "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/BatchCreateWorkOrderTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task Spare 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": [ "Work Order Task Spare" ], "summary": "Update a collection of existing Work Order Task Spare 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 | WorkOrderTaskSpare->Id | integer | int64 |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n| code | WorkOrderTaskSpare->Code | string | |\r\n| costCentreId | WorkOrderTaskSpare->CostCentre_Id | integer | int64 |\r\n| costElementId | WorkOrderTaskSpare->CostElement_Id | integer | int64 |\r\n| description | WorkOrderTaskSpare->Description | string | |\r\n| generalLedgerId | WorkOrderTaskSpare->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | WorkOrderTaskSpare->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | WorkOrderTaskSpare->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSpare->SequenceNumber | integer | int32 |\r\n| requiredOn | WorkOrderTaskSpare->RequiredOn | string | date-time |\r\n| quantityRequired | WorkOrderTaskSpare->QuantityRequired | number | decimal |\r\n| quantityUsed | WorkOrderTaskSpare->QuantityUsed | number | decimal |\r\n| spareToWorkOrderCurrencyRateId | WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id | integer | int64 |\r\n| supplierId | WorkOrderTaskSpare->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | WorkOrderTaskSpare->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | WorkOrderTaskSpare->UnitPriceInSpareCurrency | 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 | Read-only | True | WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem' |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem' |\r\n| generalLedgerId | Nullable | False | |\r\n| quantityRequired | Nullable | False | |\r\n| quantityUsed | Nullable | False | |\r\n| quantityUsed | Min Value | >= 0| |\r\n| spareToWorkOrderCurrencyRateId | Nullable | False | |\r\n| supplierId | Nullable | False | WorkOrderTaskSpare->SpareType NE 'StockItem' |\r\n| unitPriceInSpareCurrency | Nullable | False | |\r\n| unitPriceInSpareCurrency | Read-only | True | WorkOrderTaskSpare->SpareType EQ 'StockItem' |\r\n| unitPriceInSpareCurrency | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskSpare", "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/BatchUpdateWorkOrderTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare 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": [ "Work Order Task Spare" ], "summary": "Delete a collection of existing Work Order Task Spare 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 | WorkOrderTaskSpare->Id | integer | int64 |\r\n| version | WorkOrderTaskSpare->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": "BatchDeleteWorkOrderTaskSpare", "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/BatchDeleteWorkOrderTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare 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/WM/WorkOrders/Tasks/Spares/RequisitionItem/Batch": { "patch": { "tags": [ "Work Order Task Spare" ], "summary": "Update a collection of existing Work Order Task Spare 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 | RequisitionItem->Id | integer | int64 |\r\n| version | RequisitionItem->Version | integer | int32 |\r\n| code | RequisitionItem->Code | string | |\r\n| costCentreId | RequisitionItem->CostCentre_Id | integer | int64 |\r\n| costElementId | RequisitionItem->CostElement_Id | integer | int64 |\r\n| description | RequisitionItem->Description | string | |\r\n| financialYearPeriodId | RequisitionItem->FinancialYearPeriod_Id | integer | int64 |\r\n| generalLedgerId | RequisitionItem->GeneralLedger_Id | integer | int64 |\r\n| notes | RequisitionItem->Notes | string | |\r\n| quantityRequired | RequisitionItem->QuantityRequired | number | decimal |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| quantityOrdered | RequisitionItem->QuantityOrdered | number | decimal |\r\n| quantityReserved | RequisitionItem->QuantityReserved | number | decimal |\r\n| requiredOn | RequisitionItem->RequiredOn | string | date-time |\r\n| sequenceNumber | RequisitionItem->SequenceNumber | integer | int32 |\r\n| spareToWorkOrderCurrencyRateValue | RequisitionItem->SpareToWorkOrderCurrencyRateValue | number | decimal |\r\n| supplierId | RequisitionItem->Supplier_Id | integer | int64 |\r\n| unitOfMeasurementId | RequisitionItem->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPriceInSpareCurrency | RequisitionItem->UnitPriceInSpareCurrency | 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| quantityRequired | Nullable | False | |\r\n| quantityRequired | Min Value | >= 0| |\r\n| quantityOrdered | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskSpareRequisitionItem", "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/BatchUpdateWorkOrderTaskSpareRequisitionItemResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare 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/WM/WorkOrders/Tasks/Spares/{id}/AddSpareToNewRequisition": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Generate a Work Order Task Spare for the Work Order Task Spare 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 | AddSpareToNewRequisition->Code | string | |\r\n| permissionTreeId | AddSpareToNewRequisition->PermissionTree_Id | integer | int64 |\r\n| requesterType | AddSpareToNewRequisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requesterContactId | AddSpareToNewRequisition->RequesterContact_Id | integer | int64 |\r\n| requester | AddSpareToNewRequisition->Requester | string | |\r\n| requestedOn | AddSpareToNewRequisition->RequestedOn | string | date-time |\r\n| sequenceNumber | AddSpareToNewRequisition->SequenceNumber | integer | int32 |\r\n| notes | AddSpareToNewRequisition->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 | System Generated | true | If no value specified |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requestedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "AddSpareToNewRequisitionForWorkOrderTaskSpare", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/AddSpareToNewRequisitionForWorkTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/{id}/AddSpareToRequisition": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Add the Work Order Task Spare to the specified Requisition.", "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| requisitionId | AddSpareToRequisition->Requisition_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| requisitionId | Required | True | |\r\n| requisitionId | Nullable | False | |\r\n\r\n", "operationId": "AddSpareToRequisitionForWorkOrderTaskSpare", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/AddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/Batch/AddSpareToNewRequisition": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Generate Requisitions for a collection of Work Order Task Spare resources. If the items in the collection of Work Order Task Spare are from more than one Work Order then a Requisition will be generated for each Work Order", "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| entityIds | AddSpareToNewRequisition->EntityIds | array | array |\r\n| permissionTreeId | AddSpareToNewRequisition->PermissionTree_Id | integer | int64 |\r\n| code | AddSpareToNewRequisition->Code | string | |\r\n| requesterType | AddSpareToNewRequisition->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requesterContactId | AddSpareToNewRequisition->RequesterContact_Id | integer | int64 |\r\n| requester | AddSpareToNewRequisition->Requester | string | |\r\n| requestedOn | AddSpareToNewRequisition->RequestedOn | string | date-time |\r\n| sequenceNumber | AddSpareToNewRequisition->SequenceNumber | integer | int32 |\r\n| notes | AddSpareToNewRequisition->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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| code | System Generated | true | If no value specified |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| requestedOn | Required | True | |\r\n| requestedOn | Nullable | False | |\r\n\r\n", "operationId": "BatchAddSpareToNewRequisitionForWorkOrderTaskSpare", "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/BatchAddSpareToNewRequisitionForWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/Batch/AddSpareToRequisition": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Add Requisition Items for all the Work Order Task Spares with the Work Order Task Spare Ids specified, to the Requisition specified.", "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| entityIds | AddSpareToRequisition->EntityIds | array | array |\r\n| requisitionId | AddSpareToRequisition->Requisition_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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n\r\n", "operationId": "BatchAddSpareToRequisitionForWorkOrderTaskSpare", "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/BatchAddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/Batch/IssueAll": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Issue all Items for collection of Work Order Task Spare 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| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchIssueAllWorkOrderTaskSpare", "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/BatchIssueAllWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/Batch/ReturnAll": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Return all Items for collection of Work Order Task Spare 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| entityIds | IssueReturnAll->EntityIds | array | array |\r\n| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| entityIds | Required | True | |\r\n| entityIds | Nullable | False | |\r\n| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchReturnAllWorkOrderTaskSpare", "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/BatchReturnAllWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Work Order Task Spare" ], "summary": "Change the PermissionTree for an existing Work Order Task Spare 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 | WorkOrderTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskSpare->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": "ChangeWorkOrderTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkOrderTaskSparePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/{id}/IssueAll": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Issue all Items for Work Order Task Spare 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| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "IssueAllWorkOrderTaskSpare", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/IssueAllWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/{id}/ReturnAll": { "post": { "tags": [ "Work Order Task Spare" ], "summary": "Return all Items for Work Order Task Spare 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| permissionId | IssueReturnAll->Permission_Id | integer | int64 |\r\n| financialYearPeriodId | IssueReturnAll->FinancialYearPeriod_Id | integer | int64 |\r\n| transactedOn | IssueReturnAll->TransactedOn | string | date-time |\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| permissionId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| transactedOn | System Generated | true | If no value specified |\r\n\r\n", "operationId": "ReturnAllWorkOrderTaskSpare", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ReturnAllWorkOrderTaskSpareResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Work Order Task Spare" ], "summary": "Change the PermissionTree status for a collection of existing Work Order Task Spare 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 | WorkOrderTaskSpare->Id | integer | int64 |\r\n| version | WorkOrderTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | WorkOrderTaskSpare->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": "BatchChangeWorkOrderTaskSparePermissionTree", "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/BatchChangeWorkOrderTaskSparePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkOrders/Tasks/Spares/FileAttachments/{id}/Download": { "get": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Download the content for a Work Order Task Spare File Attachment resource.", "description": "", "operationId": "GetWorkOrderTaskSpareFileAttachmentContent", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of attachment content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/{id}": { "get": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Get a Work Order Task Spare File Attachment 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| workOrderTaskSpareId | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Description | string | |\r\n| createdByUserId | WorkOrderTaskSpareFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSpareFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSpareFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSpareFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkOrderTaskSpareFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkOrderTaskSpareFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkOrderTaskSpareFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkOrderTaskSpareFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkOrderTaskSpareFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkOrderTaskSpareFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkOrderTaskSpareFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkOrderTaskSpareFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkOrderTaskSpareFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkOrderTaskSpareFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskSpareFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskSpareFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkOrderTaskSpareFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkOrderTaskSpareFileAttachment->FileFullName | string | |\r\n| fileName | WorkOrderTaskSpareFileAttachment->FileName | string | |\r\n| fileTypeId | WorkOrderTaskSpareFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkOrderTaskSpareFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| id | WorkOrderTaskSpareFileAttachment->Id | integer | int64 |\r\n| isActive | WorkOrderTaskSpareFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderTaskSpareFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskSpareFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskSpareFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskSpareFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskSpareFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpareFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetWorkOrderTaskSpareFileAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Spare File Attachment", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Update an existing Work Order Task Spare File Attachment 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 | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | WorkOrderTaskSpareFileAttachment->FileName | string | |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | 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| fileName | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskSpareFileAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare File Attachment 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": [ "Work Order Task Spare File Attachment" ], "summary": "Delete an existing Work Order Task Spare File Attachment 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 | WorkOrderTaskSpareFileAttachment->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": "DeleteWorkOrderTaskSpareFileAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkOrderTaskSpareFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare File Attachment 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/WM/WorkOrders/Tasks/Spares/{id}/FileAttachments": { "get": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Get a collection of Work Order Task Spare File Attachment resources for the Work Order Task Spare.", "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 | WorkOrderTaskSpareFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n| fileFullName | WorkOrderTaskSpareFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkOrderTaskSpareFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskSpareFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskSpareFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkOrderTaskSpareFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpareFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkOrderTaskSpareFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderTaskSpareFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderTaskSpareFileAttachmentCollectionForWorkOrderTaskSpare", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "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 Work Order Task Spare File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareFileAttachmentCollectionForWorkOrderTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments": { "get": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Get a collection of Work Order Task Spare File Attachment 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 | WorkOrderTaskSpareFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n| workOrderTaskSpareId | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Description | string | |\r\n| fileFullName | WorkOrderTaskSpareFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkOrderTaskSpareFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | WorkOrderTaskSpareFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskSpareFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskSpareFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkOrderTaskSpareFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpareFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkOrderTaskSpareFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderTaskSpareFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderTaskSpareFileAttachmentCollection", "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 Work Order Task Spare File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/Upload": { "post": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Upload and create a new Work Order Task Spare File Attachment 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| workOrderTaskSpareId | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id | integer | int64 |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderTaskSpareFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskSpareFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkOrderTaskSpareFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderTaskSpareId | Required | True | |\r\n| workOrderTaskSpareId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderTaskSpareFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateWorkOrderTaskSpareFileAttachmentResourceActionRequest" } } ], "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" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/{id}/Upload": { "put": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Upload new content for an existing Work Order Task Spare File Attachment 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 | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n| bytes | WorkOrderTaskSpareFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkOrderTaskSpareFileAttachmentContent", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskSpareFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Get a collection of Work Order Task Spare File Attachment 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| workOrderTaskSpareId | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Description | string | |\r\n| createdByUserId | WorkOrderTaskSpareFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSpareFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSpareFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSpareFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkOrderTaskSpareFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkOrderTaskSpareFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkOrderTaskSpareFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkOrderTaskSpareFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkOrderTaskSpareFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkOrderTaskSpareFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkOrderTaskSpareFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkOrderTaskSpareFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkOrderTaskSpareFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkOrderTaskSpareFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkOrderTaskSpareFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkOrderTaskSpareFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkOrderTaskSpareFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkOrderTaskSpareFileAttachment->FileFullName | string | |\r\n| fileName | WorkOrderTaskSpareFileAttachment->FileName | string | |\r\n| fileTypeId | WorkOrderTaskSpareFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkOrderTaskSpareFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| id | WorkOrderTaskSpareFileAttachment->Id | integer | int64 |\r\n| isActive | WorkOrderTaskSpareFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkOrderTaskSpareFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskSpareFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskSpareFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskSpareFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskSpareFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpareFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetWorkOrderTaskSpareFileAttachment", "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 Work Order Task Spare File Attachment 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 Work Order Task Spare File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskSpareFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Work Order Task Spare File Attachment.", "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 | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetWorkOrderTaskSpareFileAttachmentContentHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Spare File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/Upload/Batch": { "post": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Upload and create a new collection of Work Order Task Spare File Attachment 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| workOrderTaskSpareId | WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id | integer | int64 |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderTaskSpareFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkOrderTaskSpareFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkOrderTaskSpareFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderTaskSpareId | Required | True | |\r\n| workOrderTaskSpareId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkOrderTaskSpareFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateWorkOrderTaskSpareFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Order Task Spare File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/FileAttachments/Batch": { "patch": { "tags": [ "Work Order Task Spare File Attachment" ], "summary": "Update a collection of existing Work Order Task Spare File Attachment 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 | WorkOrderTaskSpareFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareFileAttachment->Version | integer | int32 |\r\n| isRestricted | WorkOrderTaskSpareFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkOrderTaskSpareFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkOrderTaskSpareFileAttachment->FileCategory_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| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkOrderTaskSpareFileAttachment", "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/BatchUpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare File Attachment 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": [ "Work Order Task Spare File Attachment" ], "summary": "Delete a collection of existing Work Order Task Spare File Attachment 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 | WorkOrderTaskSpareFileAttachment->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareFileAttachment->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": "BatchDeleteWorkOrderTaskSpareFileAttachment", "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/BatchDeleteWorkOrderTaskSpareFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Spare File Attachment 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/WM/WorkOrders/Tasks/Spares/Movements/{id}": { "get": { "tags": [ "Work Order Task Spare Movement" ], "summary": "Get a Work Order Task Spare Movement 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 | WorkOrderTaskSpareMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSpareMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSpareMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSpareMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskSpareMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpareMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskSpareMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskSpareMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSpareMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSpareMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskSpareMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskSpareMovement->WorkOrder_Code | string | |\r\n| workOrderTaskMovementId | WorkOrderTaskSpareMovement->WorkOrderTaskMovement_Id | integer | int64 |\r\n| workOrderTaskSpareId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareStockItemId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemWarehouseCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n", "operationId": "GetWorkOrderTaskSpareMovement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Spare Movement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Spare Movement", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareMovementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Movements": { "get": { "tags": [ "Work Order Task Spare Movement" ], "summary": "Get a collection of Work Order Task Spare Movement 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 | WorkOrderTaskSpareMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskSpareMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskSpareMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskSpareMovement->WorkOrder_Description | string | |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareSpareType | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| action | WorkOrderTaskSpareMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSpareMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSpareMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskSpareMovementCollection", "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 Work Order Task Spare Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Movements/{workOrderTaskMovementId}/Spares": { "get": { "tags": [ "Work Order Task Spare Movement" ], "summary": "Get a collection of Work Order Task Spare Movement resources for the Work Order Task Movement.", "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 | WorkOrderTaskSpareMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskSpareMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskSpareMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskSpareMovement->WorkOrder_Description | string | |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareSpareType | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_SpareType | string (Allowed values: [StockItem, CodedNonStockItem, DirectPurchase, Contractor]) | enum |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n| action | WorkOrderTaskSpareMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSpareMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSpareMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskSpareMovementForWorkOrderTaskMovementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskMovementId", "in": "path", "required": true, "description": "Work Order Task Movement 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 Work Order Task Spare Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSpareMovementForWorkOrderTaskMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Spares/Movements/Batch/{ids}": { "get": { "tags": [ "Work Order Task Spare Movement" ], "summary": "Get a collection of Work Order Task Spare Movement 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 | WorkOrderTaskSpareMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSpareMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSpareMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSpareMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskSpareMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSpareMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSpareMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskSpareMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSpareMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskSpareMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSpareMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSpareMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskSpareMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskSpareMovement->WorkOrder_Code | string | |\r\n| workOrderTaskMovementId | WorkOrderTaskSpareMovement->WorkOrderTaskMovement_Id | integer | int64 |\r\n| workOrderTaskSpareId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Id | integer | int64 |\r\n| workOrderTaskSpareCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code | string | |\r\n| workOrderTaskSpareDescription | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description | string | |\r\n| workOrderTaskSpareStockItemId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemMaterialMasterCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code | string | |\r\n| workOrderTaskSpareStockItemWarehouseId | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Id | integer | int64 |\r\n| workOrderTaskSpareStockItemWarehouseCode | WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code | string | |\r\n", "operationId": "BatchGetWorkOrderTaskSpareMovement", "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 Work Order Task Spare Movement 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 Work Order Task Spare Movement collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskSpareMovementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/SubTasks/{id}": { "get": { "tags": [ "Work Order Task Sub Task" ], "summary": "Get a Work Order Task Sub Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | WorkOrderTaskSubTask->Code | string | |\r\n| createdByUserId | WorkOrderTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskSubTask->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskSubTask->Version | integer | int32 |\r\n| disabledReasons | WorkOrderTaskSubTask->DisabledReasons | array | enum |\r\n| id | WorkOrderTaskSubTask->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskSubTask->IsEnabled | boolean | |\r\n| workOrderTaskId | WorkOrderTaskSubTask->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskSubTask->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskSubTask->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSubTask->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Description | string | |\r\n| alternativeDescription | WorkOrderTaskSubTask->AlternativeDescription | string | |\r\n| completed | WorkOrderTaskSubTask->Completed | boolean | |\r\n| completedOn | WorkOrderTaskSubTask->CompletedOn | string | date-time |\r\n| description | WorkOrderTaskSubTask->Description | string | |\r\n| notes | WorkOrderTaskSubTask->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSubTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTaskSubTask->StartedOn | string | date-time |\r\n| taskSubTaskId | WorkOrderTaskSubTask->TaskSubTaskId | integer | int64 |\r\n| taskSubTaskType | WorkOrderTaskSubTask->TaskSubTaskType | string (Allowed values: [RegularAssetTaskSubTask, StandardTaskSubTask]) | enum |\r\n", "operationId": "GetWorkOrderTaskSubTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Sub Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Sub Task", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Order Task Sub Task" ], "summary": "Update an existing Work Order Task Sub Task 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 | WorkOrderTaskSubTask->Version | integer | int32 |\r\n| notes | WorkOrderTaskSubTask->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSubTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTaskSubTask->StartedOn | string | date-time |\r\n| completed | WorkOrderTaskSubTask->Completed | boolean | |\r\n| completedOn | WorkOrderTaskSubTask->CompletedOn | string | date-time |\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": "UpdateWorkOrderTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkOrderTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Sub Task 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/WM/WorkOrders/Tasks/{workOrderTaskId}/SubTasks": { "get": { "tags": [ "Work Order Task Sub Task" ], "summary": "Get a collection of Work Order Task Sub Task resources for the Work Order Task", "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 | WorkOrderTaskSubTask->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTask->Version | integer | int32 |\r\n| alternativeDescription | WorkOrderTaskSubTask->AlternativeDescription | string | |\r\n| code | WorkOrderTaskSubTask->Code | string | |\r\n| description | WorkOrderTaskSubTask->Description | string | |\r\n| sequenceNumber | WorkOrderTaskSubTask->SequenceNumber | integer | int32 |\r\n| completed | WorkOrderTaskSubTask->Completed | boolean | |\r\n| completedOn | WorkOrderTaskSubTask->CompletedOn | string | date-time |\r\n| isEnabled | WorkOrderTaskSubTask->IsEnabled | boolean | |\r\n| startedOn | WorkOrderTaskSubTask->StartedOn | string | date-time |\r\n| notes | WorkOrderTaskSubTask->Notes | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSubTask->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| taskSubTaskType | WorkOrderTaskSubTask->TaskSubTaskType | string (Allowed values: [RegularAssetTaskSubTask, StandardTaskSubTask]) | enum |\r\n", "operationId": "GetWorkOrderTaskSubTaskForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskId", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Sub Task collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/SubTasks": { "get": { "tags": [ "Work Order Task Sub Task" ], "summary": "Get a collection of Work Order Task Sub Task resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderTaskSubTask->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTask->Version | integer | int32 |\r\n| alternativeDescription | WorkOrderTaskSubTask->AlternativeDescription | string | |\r\n| code | WorkOrderTaskSubTask->Code | string | |\r\n| completed | WorkOrderTaskSubTask->Completed | boolean | |\r\n| completedOn | WorkOrderTaskSubTask->CompletedOn | string | date-time |\r\n| description | WorkOrderTaskSubTask->Description | string | |\r\n| sequenceNumber | WorkOrderTaskSubTask->SequenceNumber | integer | int32 |\r\n| taskSubTaskId | WorkOrderTaskSubTask->TaskSubTaskId | integer | int64 |\r\n| startedOn | WorkOrderTaskSubTask->StartedOn | string | date-time |\r\n| taskSubTaskType | WorkOrderTaskSubTask->TaskSubTaskType | string (Allowed values: [RegularAssetTaskSubTask, StandardTaskSubTask]) | enum |\r\n| isEnabled | WorkOrderTaskSubTask->IsEnabled | boolean | |\r\n| notes | WorkOrderTaskSubTask->Notes | string | |\r\n| workOrderTaskId | WorkOrderTaskSubTask->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Description | string | |\r\n| workOrderTaskWorkOrderStatusId | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Status_Id | integer | int64 |\r\n| workOrderTaskWorkOrderStatusCode | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Status_Code | string | |\r\n| workOrderTaskWorkOrderStatusDescription | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Status_Description | string | |\r\n| workOrderTaskTaskCode | WorkOrderTaskSubTask->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskSubTask->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSubTask->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| createdOn | WorkOrderTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedOn | WorkOrderTaskSubTask->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkOrderTaskSubTaskCollection", "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 Work Order Task Sub Task collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/SubTasks/Batch/{ids}": { "get": { "tags": [ "Work Order Task Sub Task" ], "summary": "Get a collection of Work Order Task Sub Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | WorkOrderTaskSubTask->Code | string | |\r\n| createdByUserId | WorkOrderTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskSubTask->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskSubTask->Version | integer | int32 |\r\n| disabledReasons | WorkOrderTaskSubTask->DisabledReasons | array | enum |\r\n| id | WorkOrderTaskSubTask->Id | integer | int64 |\r\n| isEnabled | WorkOrderTaskSubTask->IsEnabled | boolean | |\r\n| workOrderTaskId | WorkOrderTaskSubTask->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskSubTask->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskSubTask->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskTaskType | WorkOrderTaskSubTask->WorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Description | string | |\r\n| alternativeDescription | WorkOrderTaskSubTask->AlternativeDescription | string | |\r\n| completed | WorkOrderTaskSubTask->Completed | boolean | |\r\n| completedOn | WorkOrderTaskSubTask->CompletedOn | string | date-time |\r\n| description | WorkOrderTaskSubTask->Description | string | |\r\n| notes | WorkOrderTaskSubTask->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSubTask->SequenceNumber | integer | int32 |\r\n| startedOn | WorkOrderTaskSubTask->StartedOn | string | date-time |\r\n| taskSubTaskId | WorkOrderTaskSubTask->TaskSubTaskId | integer | int64 |\r\n| taskSubTaskType | WorkOrderTaskSubTask->TaskSubTaskType | string (Allowed values: [RegularAssetTaskSubTask, StandardTaskSubTask]) | enum |\r\n", "operationId": "BatchGetWorkOrderTaskSubTask", "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 Work Order Task Sub Task 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 Work Order Task Sub Task collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskSubTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/SubTasks/Batch": { "patch": { "tags": [ "Work Order Task Sub Task" ], "summary": "Update a collection of existing Work Order Task Sub Task 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 | WorkOrderTaskSubTask->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTask->Version | integer | int32 |\r\n| notes | WorkOrderTaskSubTask->Notes | string | |\r\n| sequenceNumber | WorkOrderTaskSubTask->SequenceNumber | integer | int32 |\r\n| completed | WorkOrderTaskSubTask->Completed | boolean | |\r\n| completedOn | WorkOrderTaskSubTask->CompletedOn | string | date-time |\r\n| startedOn | WorkOrderTaskSubTask->StartedOn | string | date-time |\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": "BatchUpdateWorkOrderTaskSubTask", "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/BatchUpdateWorkOrderTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Order Task Sub Task 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/WM/WorkOrders/Tasks/SubTasks/Movements/{id}": { "get": { "tags": [ "Work Order Task Sub Task Movement" ], "summary": "Get a Work Order Task Sub Task Movement 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 | WorkOrderTaskSubTaskMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSubTaskMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSubTaskMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSubTaskMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskSubTaskMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSubTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSubTaskMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskSubTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTaskMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskSubTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSubTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSubTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskSubTaskMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskSubTaskMovement->WorkOrder_Code | string | |\r\n| workOrderTaskMovementId | WorkOrderTaskSubTaskMovement->WorkOrderTaskMovement_Id | integer | int64 |\r\n| workOrderTaskSubTaskId | WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_Id | integer | int64 |\r\n| workOrderTaskSubTaskWorkOrderTaskId | WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskSubTaskWorkOrderTaskTaskCode | WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_WorkOrderTask_TaskCode | string | |\r\n", "operationId": "GetWorkOrderTaskSubTaskMovement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Sub Task Movement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Sub Task Movement", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskMovementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/SubTasks/Movements": { "get": { "tags": [ "Work Order Task Sub Task Movement" ], "summary": "Get a collection of Work Order Task Sub Task Movement 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 | WorkOrderTaskSubTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTaskMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskSubTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSubTaskMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskSubTaskMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskSubTaskMovement->WorkOrder_Description | string | |\r\n| action | WorkOrderTaskSubTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSubTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSubTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskSubTaskMovementCollection", "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 Work Order Task Sub Task Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Movements/{workOrderTaskMovementId}/SubTasks": { "get": { "tags": [ "Work Order Task Sub Task Movement" ], "summary": "Get a collection of Work Order Task Sub Task Movement resources for the Work Order Task Movement.", "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 | WorkOrderTaskSubTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTaskMovement->Version | integer | int32 |\r\n| permissionTreeCode | WorkOrderTaskSubTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSubTaskMovement->PermissionTree_Description | string | |\r\n| workOrderCode | WorkOrderTaskSubTaskMovement->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderTaskSubTaskMovement->WorkOrder_Description | string | |\r\n| action | WorkOrderTaskSubTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSubTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSubTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n", "operationId": "GetWorkOrderTaskSubTaskMovementForWorkOrderTaskMovementCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workOrderTaskMovementId", "in": "path", "required": true, "description": "Work Order Task Movement 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 Work Order Task Sub Task Movement collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskMovementForWorkOrderTaskMovementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/SubTasks/Movements/Batch/{ids}": { "get": { "tags": [ "Work Order Task Sub Task Movement" ], "summary": "Get a collection of Work Order Task Sub Task Movement 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 | WorkOrderTaskSubTaskMovement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskSubTaskMovement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskSubTaskMovement->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskSubTaskMovement->CreatedOn | string | date-time |\r\n| permissionTreeId | WorkOrderTaskSubTaskMovement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkOrderTaskSubTaskMovement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkOrderTaskSubTaskMovement->PermissionTree_Description | string | |\r\n| id | WorkOrderTaskSubTaskMovement->Id | integer | int64 |\r\n| version | WorkOrderTaskSubTaskMovement->Version | integer | int32 |\r\n| action | WorkOrderTaskSubTaskMovement->Action | string (Allowed values: [Merge, Split]) | enum |\r\n| direction | WorkOrderTaskSubTaskMovement->Direction | string (Allowed values: [Target, Source]) | enum |\r\n| result | WorkOrderTaskSubTaskMovement->Result | string (Allowed values: [Moved, Duplicate, FeedbackConstraint]) | enum |\r\n| workOrderId | WorkOrderTaskSubTaskMovement->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderTaskSubTaskMovement->WorkOrder_Code | string | |\r\n| workOrderTaskMovementId | WorkOrderTaskSubTaskMovement->WorkOrderTaskMovement_Id | integer | int64 |\r\n| workOrderTaskSubTaskId | WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_Id | integer | int64 |\r\n| workOrderTaskSubTaskWorkOrderTaskId | WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskSubTaskWorkOrderTaskTaskCode | WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_WorkOrderTask_TaskCode | string | |\r\n", "operationId": "BatchGetWorkOrderTaskSubTaskMovement", "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 Work Order Task Sub Task Movement 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 Work Order Task Sub Task Movement collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskSubTaskMovementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Warranties/{id}": { "get": { "tags": [ "Work Order Task Warranty" ], "summary": "Get a Work Order Task Warranty 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 | WorkOrderTaskWarranty->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskWarranty->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskWarranty->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskWarranty->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskWarranty->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskWarranty->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskWarranty->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskWarranty->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskWarranty->Version | integer | int32 |\r\n| id | WorkOrderTaskWarranty->Id | integer | int64 |\r\n| workOrderWarrantyId | WorkOrderTaskWarranty->WorkOrderWarranty_Id | integer | int64 |\r\n| workOrderWarrantyWarranty | WorkOrderTaskWarranty->WorkOrderWarranty_Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n| workOrderWarrantySupplierId | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Id | integer | int64 |\r\n| workOrderWarrantySupplierCode | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code | string | |\r\n| workOrderWarrantySupplierDescription | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Description | string | |\r\n| workOrderWarrantyAssetWarrantyId | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Id | integer | int64 |\r\n| workOrderWarrantyAssetWarrantyCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code | string | |\r\n| workOrderWarrantyAssetWarrantyDescription | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeId | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Id | integer | int64 |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeDescription | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Description | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyExpiryDate | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate | string | date |\r\n| workOrderTaskId | WorkOrderTaskWarranty->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskWarranty->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskWarranty->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderTaskWarranty", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task Warranty Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Task Warranty", "schema": { "$ref": "#/definitions/GetWorkOrderTaskWarrantyResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/{id}/Warranties": { "get": { "tags": [ "Work Order Task Warranty" ], "summary": "Get a collection of Warranty resources for the WorkOrderTask", "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 | WorkOrderTaskWarranty->Id | integer | int64 |\r\n| workOrderWarrantyAssetWarrantyCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code | string | |\r\n| workOrderWarrantyAssetWarrantyDescription | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyExpiryDate | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate | string | date |\r\n| workOrderWarrantySupplierCode | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code | string | |\r\n| workOrderWarrantyWarranty | WorkOrderTaskWarranty->WorkOrderWarranty_Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetWorkOrderTaskWarrantyForWorkOrderTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Task 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 Work Order Task Warranty collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskWarrantyForWorkOrderTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Warranties": { "get": { "tags": [ "Work Order Task Warranty" ], "summary": "Get a collection of Work Order Task Warranty 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 | WorkOrderTaskWarranty->Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskWarranty->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderWarrantyAssetWarrantyCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code | string | |\r\n| workOrderWarrantyAssetWarrantyDescription | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyExpiryDate | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate | string | date |\r\n| workOrderWarrantySupplierCode | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code | string | |\r\n| workOrderWarrantyWarranty | WorkOrderTaskWarranty->WorkOrderWarranty_Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetWorkOrderTaskWarrantyCollection", "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 Work Order Task Warranty collection", "schema": { "$ref": "#/definitions/GetWorkOrderTaskWarrantyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Tasks/Warranties/Batch/{ids}": { "get": { "tags": [ "Work Order Task Warranty" ], "summary": "Get a collection of Work Order Task Warranty 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 | WorkOrderTaskWarranty->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderTaskWarranty->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderTaskWarranty->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderTaskWarranty->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderTaskWarranty->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderTaskWarranty->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderTaskWarranty->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderTaskWarranty->ModifiedOn | string | date-time |\r\n| version | WorkOrderTaskWarranty->Version | integer | int32 |\r\n| id | WorkOrderTaskWarranty->Id | integer | int64 |\r\n| workOrderWarrantyId | WorkOrderTaskWarranty->WorkOrderWarranty_Id | integer | int64 |\r\n| workOrderWarrantyWarranty | WorkOrderTaskWarranty->WorkOrderWarranty_Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n| workOrderWarrantySupplierId | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Id | integer | int64 |\r\n| workOrderWarrantySupplierCode | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code | string | |\r\n| workOrderWarrantySupplierDescription | WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Description | string | |\r\n| workOrderWarrantyAssetWarrantyId | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Id | integer | int64 |\r\n| workOrderWarrantyAssetWarrantyCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code | string | |\r\n| workOrderWarrantyAssetWarrantyDescription | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeId | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Id | integer | int64 |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeCode | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyTypeDescription | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Description | string | |\r\n| workOrderWarrantyAssetWarrantyWarrantyExpiryDate | WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate | string | date |\r\n| workOrderTaskId | WorkOrderTaskWarranty->WorkOrderTask_Id | integer | int64 |\r\n| workOrderTaskTaskCode | WorkOrderTaskWarranty->WorkOrderTask_TaskCode | string | |\r\n| workOrderTaskTaskDescription | WorkOrderTaskWarranty->WorkOrderTask_TaskDescription | string | |\r\n| workOrderTaskWorkOrderId | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Id | integer | int64 |\r\n| workOrderTaskWorkOrderCode | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Code | string | |\r\n| workOrderTaskWorkOrderDescription | WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderTaskWarranty", "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 Work Order Task Warranty 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 Work Order Task Warranty collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderTaskWarrantyResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Warranties/{id}": { "get": { "tags": [ "Work Order Warranty" ], "summary": "Get a Work Order Warranty 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 | WorkOrderWarranty->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderWarranty->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderWarranty->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderWarranty->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderWarranty->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderWarranty->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderWarranty->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderWarranty->ModifiedOn | string | date-time |\r\n| version | WorkOrderWarranty->Version | integer | int32 |\r\n| id | WorkOrderWarranty->Id | integer | int64 |\r\n| assetWarrantyId | WorkOrderWarranty->AssetWarranty_Id | integer | int64 |\r\n| assetWarrantyCode | WorkOrderWarranty->AssetWarranty_Code | string | |\r\n| assetWarrantyDescription | WorkOrderWarranty->AssetWarranty_Description | string | |\r\n| assetWarrantyWarrantyExpiryDate | WorkOrderWarranty->AssetWarranty_WarrantyExpiryDate | string | date |\r\n| assetWarrantyWarrantyTypeId | WorkOrderWarranty->AssetWarranty_WarrantyType_Id | integer | int64 |\r\n| assetWarrantyWarrantyTypeCode | WorkOrderWarranty->AssetWarranty_WarrantyType_Code | string | |\r\n| assetWarrantyWarrantyTypeDescription | WorkOrderWarranty->AssetWarranty_WarrantyType_Description | string | |\r\n| warranty | WorkOrderWarranty->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n| supplierId | WorkOrderWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | WorkOrderWarranty->Supplier_Code | string | |\r\n| supplierDescription | WorkOrderWarranty->Supplier_Description | string | |\r\n| warrantyExpiryDate | WorkOrderWarranty->WarrantyExpiryDate | string | date |\r\n| workOrderId | WorkOrderWarranty->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderWarranty->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderWarranty->WorkOrder_Description | string | |\r\n", "operationId": "GetWorkOrderWarranty", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order Warranty Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Order Warranty", "schema": { "$ref": "#/definitions/GetWorkOrderWarrantyResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/{id}/Warranties": { "get": { "tags": [ "Work Order Warranty" ], "summary": "Get a collection of Work Order Warranty resources for the Work Order.", "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 | WorkOrderWarranty->Id | integer | int64 |\r\n| assetWarrantyCode | WorkOrderWarranty->AssetWarranty_Code | string | |\r\n| assetWarrantyDescription | WorkOrderWarranty->AssetWarranty_Description | string | |\r\n| assetWarrantyWarrantyTypeCode | WorkOrderWarranty->AssetWarranty_WarrantyType_Code | string | |\r\n| warrantyExpiryDate | WorkOrderWarranty->WarrantyExpiryDate | string | date |\r\n| supplierCode | WorkOrderWarranty->Supplier_Code | string | |\r\n| warranty | WorkOrderWarranty->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetWorkOrderWarrantyCollectionForWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Order 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 Work Order Warranty collection", "schema": { "$ref": "#/definitions/GetWorkOrderWarrantyCollectionForWorkOrderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Warranties": { "get": { "tags": [ "Work Order Warranty" ], "summary": "Get a collection of Work Order Warranty 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 | WorkOrderWarranty->Id | integer | int64 |\r\n| assetWarrantyCode | WorkOrderWarranty->AssetWarranty_Code | string | |\r\n| assetWarrantyDescription | WorkOrderWarranty->AssetWarranty_Description | string | |\r\n| assetWarrantyWarrantyTypeCode | WorkOrderWarranty->AssetWarranty_WarrantyType_Code | string | |\r\n| workOrderCode | WorkOrderWarranty->WorkOrder_Code | string | |\r\n| warrantyExpiryDate | WorkOrderWarranty->WarrantyExpiryDate | string | date |\r\n| supplierCode | WorkOrderWarranty->Supplier_Code | string | |\r\n| warranty | WorkOrderWarranty->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetWorkOrderWarrantyCollection", "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 Work Order Warranty collection", "schema": { "$ref": "#/definitions/GetWorkOrderWarrantyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkOrders/Warranties/Batch/{ids}": { "get": { "tags": [ "Work Order Warranty" ], "summary": "Get a collection of Work Order Warranty 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 | WorkOrderWarranty->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkOrderWarranty->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkOrderWarranty->CreatedByUser_FullName | string | |\r\n| createdOn | WorkOrderWarranty->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkOrderWarranty->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkOrderWarranty->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkOrderWarranty->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkOrderWarranty->ModifiedOn | string | date-time |\r\n| version | WorkOrderWarranty->Version | integer | int32 |\r\n| id | WorkOrderWarranty->Id | integer | int64 |\r\n| assetWarrantyId | WorkOrderWarranty->AssetWarranty_Id | integer | int64 |\r\n| assetWarrantyCode | WorkOrderWarranty->AssetWarranty_Code | string | |\r\n| assetWarrantyDescription | WorkOrderWarranty->AssetWarranty_Description | string | |\r\n| assetWarrantyWarrantyExpiryDate | WorkOrderWarranty->AssetWarranty_WarrantyExpiryDate | string | date |\r\n| assetWarrantyWarrantyTypeId | WorkOrderWarranty->AssetWarranty_WarrantyType_Id | integer | int64 |\r\n| assetWarrantyWarrantyTypeCode | WorkOrderWarranty->AssetWarranty_WarrantyType_Code | string | |\r\n| assetWarrantyWarrantyTypeDescription | WorkOrderWarranty->AssetWarranty_WarrantyType_Description | string | |\r\n| warranty | WorkOrderWarranty->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n| supplierId | WorkOrderWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | WorkOrderWarranty->Supplier_Code | string | |\r\n| supplierDescription | WorkOrderWarranty->Supplier_Description | string | |\r\n| warrantyExpiryDate | WorkOrderWarranty->WarrantyExpiryDate | string | date |\r\n| workOrderId | WorkOrderWarranty->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkOrderWarranty->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkOrderWarranty->WorkOrder_Description | string | |\r\n", "operationId": "BatchGetWorkOrderWarranty", "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 Work Order Warranty 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 Work Order Warranty collection", "schema": { "$ref": "#/definitions/BatchGetWorkOrderWarrantyResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/{id}": { "get": { "tags": [ "Work Request" ], "summary": "Get a Work Request 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| geographicId | WorkRequest->GeographicId | integer | int64 |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | WorkRequest->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicLocation | WorkRequest->GeographicLocation | object | |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | WorkRequest->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | WorkRequest->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | WorkRequest->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequest->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequest->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequest->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkRequest->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequest->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequest->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequest->ModifiedOn | string | date-time |\r\n| version | WorkRequest->Version | integer | int32 |\r\n| permissionTreeId | WorkRequest->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequest->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequest->PermissionTree_Description | string | |\r\n| code | WorkRequest->Code | string | |\r\n| codeCounter | WorkRequest->CodeCounter | integer | int64 |\r\n| codePrefix | WorkRequest->CodePrefix | string | |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| siteCode | WorkRequest->Site_Code | string | |\r\n| siteDescription | WorkRequest->Site_Description | string | |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterContactId | WorkRequest->RequesterContact_Id | integer | int64 |\r\n| requesterContactCode | WorkRequest->RequesterContact_Code | string | |\r\n| id | WorkRequest->Id | integer | int64 |\r\n| address | WorkRequest->Address | string | |\r\n| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| assetCode | WorkRequest->Asset_Code | string | |\r\n| assetDescription | WorkRequest->Asset_Description | string | |\r\n| description | WorkRequest->Description | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| failedComponentCode | WorkRequest->FailedComponent_Code | string | |\r\n| failedComponentDescription | WorkRequest->FailedComponent_Description | string | |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone1TypeCode | WorkRequest->Phone1Type_Code | string | |\r\n| phone1TypeDescription | WorkRequest->Phone1Type_Description | string | |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| latestWorkRequestStatusChangeId | WorkRequest->LatestWorkRequestStatusChange_Id | integer | int64 |\r\n| latestWorkRequestStatusChangeRemark | WorkRequest->LatestWorkRequestStatusChange_Remark | string | |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| phone2TypeCode | WorkRequest->Phone2Type_Code | string | |\r\n| phone2TypeDescription | WorkRequest->Phone2Type_Description | string | |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | WorkRequest->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | WorkRequest->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| responsibleStaffMemberCode | WorkRequest->ResponsibleStaffMember_Code | string | |\r\n| responsibleStaffMemberResourceType | WorkRequest->ResponsibleStaffMember_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| statusId | WorkRequest->Status_Id | integer | int64 |\r\n| statusCode | WorkRequest->Status_Code | string | |\r\n| statusDescription | WorkRequest->Status_Description | string | |\r\n| statusBaseStatus | WorkRequest->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | WorkRequest->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkRequest->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | WorkRequest->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | WorkRequest->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workOrderId | WorkRequest->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkRequest->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkRequest->WorkOrder_Description | string | |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n", "operationId": "GetWorkRequest", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request", "schema": { "$ref": "#/definitions/GetWorkRequestResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Request" ], "summary": "Update an existing Work Request 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 | WorkRequest->Version | integer | int32 |\r\n| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| address | WorkRequest->Address | string | |\r\n| description | WorkRequest->Description | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterContactId | WorkRequest->RequesterContact_Id | integer | int64 |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| workOrderId | WorkRequest->WorkOrder_Id | integer | int64 |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| geographicLocation | WorkRequest->GeographicLocation | object | |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| assetId | Min Value | > 1| |\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| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| failedComponentId | Nullable | True | WorkRequest->Asset_Id eq null |\r\n| motionType | Nullable | False | |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | WorkRequest->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkRequest->RequesterType eq 'FreeText' |\r\n| requesterContactId | Nullable | True | WorkRequest->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkRequest->RequesterType eq 'Contact' |\r\n| requesterType | Nullable | False | |\r\n| siteId | Nullable | False | |\r\n| workRequested | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkRequest", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkRequestResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests": { "get": { "tags": [ "Work Request" ], "summary": "Get a collection of Work Request 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 | WorkRequest->Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| description | WorkRequest->Description | string | |\r\n| address | WorkRequest->Address | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| assetCode | WorkRequest->Asset_Code | string | |\r\n| assetDescription | WorkRequest->Asset_Description | string | |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| failedComponentCode | WorkRequest->FailedComponent_Code | string | |\r\n| failedComponentDescription | WorkRequest->FailedComponent_Description | string | |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| permissionTreeId | WorkRequest->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequest->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequest->PermissionTree_Description | string | |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone1TypeCode | WorkRequest->Phone1Type_Code | string | |\r\n| phone1TypeDescription | WorkRequest->Phone1Type_Description | string | |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| phone2TypeCode | WorkRequest->Phone2Type_Code | string | |\r\n| phone2TypeDescription | WorkRequest->Phone2Type_Description | string | |\r\n| workOrderId | WorkRequest->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkRequest->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkRequest->WorkOrder_Description | string | |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | WorkRequest->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | WorkRequest->ResponsibleSection_Description | string | |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| siteCode | WorkRequest->Site_Code | string | |\r\n| siteDescription | WorkRequest->Site_Description | string | |\r\n| statusId | WorkRequest->Status_Id | integer | int64 |\r\n| statusCode | WorkRequest->Status_Code | string | |\r\n| statusDescription | WorkRequest->Status_Description | string | |\r\n| statusBaseStatus | WorkRequest->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | WorkRequest->TypeOfWork_Code | string | |\r\n| version | WorkRequest->Version | integer | int32 |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| responsibleStaffMemberCode | WorkRequest->ResponsibleStaffMember_Code | string | |\r\n", "operationId": "GetWorkRequestCollection", "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 Work Request collection", "schema": { "$ref": "#/definitions/GetWorkRequestCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Request" ], "summary": "Create a new Work Request 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| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| address | WorkRequest->Address | string | |\r\n| description | WorkRequest->Description | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| permissionTreeId | WorkRequest->PermissionTree_Id | integer | int64 |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterContactId | WorkRequest->RequesterContact_Id | integer | int64 |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n| geographicLocation | WorkRequest->GeographicLocation | object | |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Min Value | > 1| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | System Generated | true | If no value specified |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| failedComponentId | Nullable | True | WorkRequest->Asset_Id eq null |\r\n| motionType | Required | True | |\r\n| motionType | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| requestedOn | Required | True | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | WorkRequest->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkRequest->RequesterType eq 'FreeText' |\r\n| requesterContactId | Nullable | True | WorkRequest->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkRequest->RequesterType eq 'Contact' |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| siteId | Nullable | False | |\r\n| workRequested | Required | True | |\r\n| workRequested | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkRequest", "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/CreateWorkRequestResourceActionRequest" } }, { "$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/WM/WorkRequests/Lookups/LookupWorkRequestAsset": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Asset for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| siteId | Asset->Site_Id | integer | int64 |\r\n| siteCode | Asset->Site_Code | string | |\r\n| siteDescription | Asset->Site_Description | string | |\r\n| locationId | Asset->Location_Id | integer | int64 |\r\n| locationCode | Asset->Location_Code | string | |\r\n| locationDescription | Asset->Location_Description | string | |\r\n| isMsi | Asset->IsMsi | boolean | |\r\n| assetTypeCode | Asset->AssetType_Code | string | |\r\n| assetTypeDescription | Asset->AssetType_Description | string | |\r\n| barcode | Asset->Barcode | string | |\r\n", "operationId": "LookupWorkRequestAsset", "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 Asset collection", "schema": { "$ref": "#/definitions/WorkRequestAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestChangePermissionTree": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the permission set for changing the Work Request.", "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": "LookupWorkRequestChangePermissionTree", "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/WorkRequestChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestFailedComponent": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Asset Component for the Work Request.", "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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| assetTreePathItems | AssetComponent->Asset_TreePathItems | array | array |\r\n| treePathItems | AssetComponent->TreePathItems | array | array |\r\n", "operationId": "LookupWorkRequestFailedComponent", "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 Asset Component collection", "schema": { "$ref": "#/definitions/WorkRequestFailedComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestGeographicDataAssetReferenceEntity": { "get": { "tags": [ "Work Request" ], "summary": "Lookup Geographic Reference Asset for Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| siteCode | Asset->Site_Code | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| geographicLocation | Asset->GeographicLocation | object | |\r\n", "operationId": "LookupWorkRequestGeographicDataAssetReferenceEntity", "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 Asset collection", "schema": { "$ref": "#/definitions/WorkRequestGeographicDataAssetReferenceEntityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestGeographicUnitOfMeasurement": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Unit of Measurement for Work Request.", "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": "LookupWorkRequestGeographicUnitOfMeasurement", "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/WorkRequestGeographicUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestInsertPermissionTree": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the permission set for creating the Work Request.", "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": "LookupWorkRequestInsertPermissionTree", "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/WorkRequestInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestPhone1Type": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Phone Number Type for the Work Request.", "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 | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n", "operationId": "LookupWorkRequestPhone1Type", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/WorkRequestPhone1TypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestPhone2Type": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Phone Number Type for the Work Request.", "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 | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n", "operationId": "LookupWorkRequestPhone2Type", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/WorkRequestPhone2TypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestRequesterContact": { "get": { "tags": [ "Work Request" ], "summary": "Lookup up the Requester Contact for the Work Request", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupWorkRequestRequesterContact", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkRequestRequesterContactLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestResponsibleSection": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Section for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupWorkRequestResponsibleSection", "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 Section collection", "schema": { "$ref": "#/definitions/WorkRequestSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestResponsibleStaffMember": { "get": { "tags": [ "Work Request" ], "summary": "Lookup up the Staff Member for the Work Request", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupWorkRequestResponsibleStaffMember", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkRequestStaffMemberLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestSite": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Site for the Work Request.", "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": "LookupWorkRequestSite", "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/WorkRequestSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestStatus": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Work Request Status for the Work Request.", "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 | WorkRequestStatus->Id | integer | int64 |\r\n| code | WorkRequestStatus->Code | string | |\r\n| description | WorkRequestStatus->Description | string | |\r\n| baseStatus | WorkRequestStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n", "operationId": "LookupWorkRequestStatus", "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 Work Request Status collection", "schema": { "$ref": "#/definitions/WorkRequestStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestTypeOfWork": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Type of Work for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n", "operationId": "LookupWorkRequestTypeOfWork", "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 Type of Work collection", "schema": { "$ref": "#/definitions/WorkRequestTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderAsset": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Asset for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| siteId | Asset->Site_Id | integer | int64 |\r\n| siteCode | Asset->Site_Code | string | |\r\n| siteDescription | Asset->Site_Description | string | |\r\n| isMsi | Asset->IsMsi | boolean | |\r\n| assetTypeCode | Asset->AssetType_Code | string | |\r\n| assetTypeDescription | Asset->AssetType_Description | string | |\r\n| barcode | Asset->Barcode | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderAsset", "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 Asset collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderCostCentre": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Cost Centre for the Work Request.", "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 | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderCostCentre", "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 Cost Centre collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderFailedComponent": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Regular Asset Component for the Work Request.", "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 | RegularAssetComponent->Id | integer | int64 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| assetTreePathItems | RegularAssetComponent->Asset_TreePathItems | array | array |\r\n| treePathItems | RegularAssetComponent->TreePathItems | array | array |\r\n", "operationId": "LookupWorkRequestWorkOrderFailedComponent", "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 Regular Asset Component collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderFailedComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderGeneralLedger": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the General Ledger for the Work Request.", "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 | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderGeneralLedger", "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 General Ledger collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrder": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Work Order for the Work Request.", "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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n", "operationId": "LookupWorkRequestWorkOrder", "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 Work Order collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderSection": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Section for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderSection", "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 Section collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderSite": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Site for the Work Request.", "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": "LookupWorkRequestWorkOrderSite", "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/WorkRequestWorkOrderSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderStaffMember": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Resource for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderStaffMember", "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 Resource collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderStaffMemberLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderTrade": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Trade for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderTrade", "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 Trade collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderTypeOfWork": { "get": { "tags": [ "Work Request" ], "summary": "Lookup the Type of Work for the Work Request.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n", "operationId": "LookupWorkRequestWorkOrderTypeOfWork", "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 Type of Work collection", "schema": { "$ref": "#/definitions/WorkRequestWorkOrderTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Batch/{ids}": { "get": { "tags": [ "Work Request" ], "summary": "Get a collection of Work Request 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| geographicId | WorkRequest->GeographicId | integer | int64 |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | WorkRequest->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicLocation | WorkRequest->GeographicLocation | object | |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | WorkRequest->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | WorkRequest->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | WorkRequest->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequest->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequest->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequest->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkRequest->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequest->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequest->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequest->ModifiedOn | string | date-time |\r\n| version | WorkRequest->Version | integer | int32 |\r\n| permissionTreeId | WorkRequest->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequest->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequest->PermissionTree_Description | string | |\r\n| code | WorkRequest->Code | string | |\r\n| codeCounter | WorkRequest->CodeCounter | integer | int64 |\r\n| codePrefix | WorkRequest->CodePrefix | string | |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| siteCode | WorkRequest->Site_Code | string | |\r\n| siteDescription | WorkRequest->Site_Description | string | |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterContactId | WorkRequest->RequesterContact_Id | integer | int64 |\r\n| requesterContactCode | WorkRequest->RequesterContact_Code | string | |\r\n| id | WorkRequest->Id | integer | int64 |\r\n| address | WorkRequest->Address | string | |\r\n| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| assetCode | WorkRequest->Asset_Code | string | |\r\n| assetDescription | WorkRequest->Asset_Description | string | |\r\n| description | WorkRequest->Description | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| failedComponentCode | WorkRequest->FailedComponent_Code | string | |\r\n| failedComponentDescription | WorkRequest->FailedComponent_Description | string | |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone1TypeCode | WorkRequest->Phone1Type_Code | string | |\r\n| phone1TypeDescription | WorkRequest->Phone1Type_Description | string | |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| latestWorkRequestStatusChangeId | WorkRequest->LatestWorkRequestStatusChange_Id | integer | int64 |\r\n| latestWorkRequestStatusChangeRemark | WorkRequest->LatestWorkRequestStatusChange_Remark | string | |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| phone2TypeCode | WorkRequest->Phone2Type_Code | string | |\r\n| phone2TypeDescription | WorkRequest->Phone2Type_Description | string | |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | WorkRequest->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | WorkRequest->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| responsibleStaffMemberCode | WorkRequest->ResponsibleStaffMember_Code | string | |\r\n| responsibleStaffMemberResourceType | WorkRequest->ResponsibleStaffMember_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| statusId | WorkRequest->Status_Id | integer | int64 |\r\n| statusCode | WorkRequest->Status_Code | string | |\r\n| statusDescription | WorkRequest->Status_Description | string | |\r\n| statusBaseStatus | WorkRequest->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | WorkRequest->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | WorkRequest->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkType | WorkRequest->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| typeOfWorkWorkClass | WorkRequest->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workOrderId | WorkRequest->WorkOrder_Id | integer | int64 |\r\n| workOrderCode | WorkRequest->WorkOrder_Code | string | |\r\n| workOrderDescription | WorkRequest->WorkOrder_Description | string | |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n", "operationId": "BatchGetWorkRequest", "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 Work Request 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 Work Request collection", "schema": { "$ref": "#/definitions/BatchGetWorkRequestResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Batch": { "post": { "tags": [ "Work Request" ], "summary": "Create a new collection of Work Request 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| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| address | WorkRequest->Address | string | |\r\n| description | WorkRequest->Description | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| permissionTreeId | WorkRequest->PermissionTree_Id | integer | int64 |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterContactId | WorkRequest->RequesterContact_Id | integer | int64 |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| geographicLocation | WorkRequest->GeographicLocation | object | |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Min Value | > 1| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | System Generated | true | If no value specified |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| failedComponentId | Nullable | True | WorkRequest->Asset_Id eq null |\r\n| motionType | Required | True | |\r\n| motionType | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| requestedOn | Required | True | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | WorkRequest->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkRequest->RequesterType eq 'FreeText' |\r\n| requesterContactId | Nullable | True | WorkRequest->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkRequest->RequesterType eq 'Contact' |\r\n| requesterType | Required | True | |\r\n| requesterType | Nullable | False | |\r\n| siteId | Nullable | False | |\r\n| workRequested | Required | True | |\r\n| workRequested | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkRequest", "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/BatchCreateWorkRequestResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request" ], "summary": "Update a collection of existing Work Request 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| version | WorkRequest->Version | integer | int32 |\r\n| id | WorkRequest->Id | integer | int64 |\r\n| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| address | WorkRequest->Address | string | |\r\n| description | WorkRequest->Description | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterContactId | WorkRequest->RequesterContact_Id | integer | int64 |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| siteId | WorkRequest->Site_Id | integer | int64 |\r\n| workOrderId | WorkRequest->WorkOrder_Id | integer | int64 |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| geographicLocation | WorkRequest->GeographicLocation | object | |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| assetId | Min Value | > 1| |\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| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| failedComponentId | Nullable | True | WorkRequest->Asset_Id eq null |\r\n| motionType | Nullable | False | |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | WorkRequest->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkRequest->RequesterType eq 'FreeText' |\r\n| requesterContactId | Nullable | True | WorkRequest->RequesterType eq 'User' |\r\n| requesterContactId | Nullable | False | WorkRequest->RequesterType eq 'Contact' |\r\n| requesterType | Nullable | False | |\r\n| siteId | Nullable | False | |\r\n| workRequested | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkRequest", "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/BatchUpdateWorkRequestResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests/{id}/PermissionTree": { "patch": { "tags": [ "Work Request" ], "summary": "Change the PermissionTree for an existing Work Request 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 | WorkRequest->Version | integer | int32 |\r\n| permissionTreeId | WorkRequest->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": "ChangeWorkRequestPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/CreateWorkOrder": { "post": { "tags": [ "Work Request" ], "summary": "Create Work Order for Work Requests.", "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| workRequestIds | CreateWorkOrderForWorkRequests->WorkRequestIds | array | array |\r\n| siteId | CreateWorkOrderForWorkRequests->Site_Id | integer | int64 |\r\n| assetId | CreateWorkOrderForWorkRequests->Asset_Id | integer | int64 |\r\n| estimatedDuration | CreateWorkOrderForWorkRequests->EstimatedDuration | string | duration |\r\n| motionType | CreateWorkOrderForWorkRequests->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| requester | CreateWorkOrderForWorkRequests->Requester | string | |\r\n| requesterContactId | CreateWorkOrderForWorkRequests->RequesterContact_Id | integer | int64 |\r\n| requesterType | CreateWorkOrderForWorkRequests->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | CreateWorkOrderForWorkRequests->RequiredBy | string | date-time |\r\n| sectionId | CreateWorkOrderForWorkRequests->Section_Id | integer | int64 |\r\n| staffMemberId | CreateWorkOrderForWorkRequests->StaffMember_Id | integer | int64 |\r\n| tradeId | CreateWorkOrderForWorkRequests->Trade_Id | integer | int64 |\r\n| typeOfWorkId | CreateWorkOrderForWorkRequests->TypeOfWork_Id | integer | int64 |\r\n| generalLedgerId | CreateWorkOrderForWorkRequests->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | CreateWorkOrderForWorkRequests->CostCentre_Id | integer | int64 |\r\n| failedComponentId | CreateWorkOrderForWorkRequests->FailedComponent_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| workRequestIds | Required | True | |\r\n| workRequestIds | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkOrderForWorkRequests", "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/CreateWorkOrderForWorkRequestsResourceActionRequest" } }, { "$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/WM/WorkRequests/LinkWorkOrder": { "post": { "tags": [ "Work Request" ], "summary": "Link work order.", "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| workOrderId | LinkWorkOrderToWorkRequests->WorkOrderId | integer | int64 |\r\n| workRequestIds | LinkWorkOrderToWorkRequests->WorkRequestIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workOrderId | Required | True | |\r\n| workOrderId | Nullable | False | |\r\n| workRequestIds | Required | True | |\r\n| workRequestIds | Nullable | False | |\r\n\r\n", "operationId": "LinkWorkOrderToWorkRequests", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "workRequests", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/LinkWorkOrderToWorkRequestsResourceActionRequest" } }, { "$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/WM/WorkRequests/Status/Batch": { "post": { "tags": [ "Work Request" ], "summary": "Change the status for a collection of Work Request 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| workRequestId | WorkRequestStatusChange->WorkRequest_Id | integer | int64 |\r\n| version | WorkRequestStatusChange->Version | integer | int32 |\r\n| statusId | WorkRequestStatusChange->Status_Id | integer | int64 |\r\n| statusChangedOn | WorkRequestStatusChange->StatusChangedOn | string | date-time |\r\n| remark | WorkRequestStatusChange->Remark | 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| workRequestId | Required | True | |\r\n| workRequestId | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| statusId | Required | True | |\r\n| statusId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeWorkRequestStatus", "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/BatchChangeWorkRequestStatusResourceActionRequest" } }, { "$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/WM/WorkRequests/Status": { "post": { "tags": [ "Work Request" ], "summary": "Change the status for the Work Request 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| workRequestId | WorkRequestStatusChange->WorkRequest_Id | integer | int64 |\r\n| version | WorkRequestStatusChange->Version | integer | int32 |\r\n| statusId | WorkRequestStatusChange->Status_Id | integer | int64 |\r\n| statusChangedOn | WorkRequestStatusChange->StatusChangedOn | string | date-time |\r\n| remark | WorkRequestStatusChange->Remark | 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| workRequestId | Required | True | |\r\n| workRequestId | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| statusId | Required | True | |\r\n| statusId | Nullable | False | |\r\n\r\n", "operationId": "ChangeWorkRequestStatus", "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/ChangeWorkRequestStatusResourceActionRequest" } }, { "$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/WM/WorkRequests/Batch/PermissionTree": { "patch": { "tags": [ "Work Request" ], "summary": "Change the PermissionTree status for a collection of existing Work Request 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 | WorkRequest->Id | integer | int64 |\r\n| version | WorkRequest->Version | integer | int32 |\r\n| permissionTreeId | WorkRequest->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": "BatchChangeWorkRequestPermissionTree", "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/BatchChangeWorkRequestPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/MatchBatch": { "patch": { "tags": [ "Work Request" ], "summary": "Update a collection of existing Work Request 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| version | WorkRequest->Version | integer | int32 |\r\n| id | WorkRequest->Id | integer | int64 |\r\n| assetId | WorkRequest->Asset_Id | integer | int64 |\r\n| address | WorkRequest->Address | string | |\r\n| email | WorkRequest->Email | string | email |\r\n| estimatedDuration | WorkRequest->EstimatedDuration | string | duration |\r\n| failedComponentId | WorkRequest->FailedComponent_Id | integer | int64 |\r\n| motionType | WorkRequest->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | WorkRequest->Notes | string | |\r\n| phone1 | WorkRequest->Phone1 | string | phone |\r\n| phone2 | WorkRequest->Phone2 | string | phone |\r\n| phone1TypeId | WorkRequest->Phone1Type_Id | integer | int64 |\r\n| phone2TypeId | WorkRequest->Phone2Type_Id | integer | int64 |\r\n| priority | WorkRequest->Priority | string (Allowed values: [High, Medium, Low]) | enum |\r\n| requestedOn | WorkRequest->RequestedOn | string | date-time |\r\n| requester | WorkRequest->Requester | string | |\r\n| requesterType | WorkRequest->RequesterType | string (Allowed values: [User, Contact, FreeText]) | enum |\r\n| requiredBy | WorkRequest->RequiredBy | string | date-time |\r\n| responsibleSectionId | WorkRequest->ResponsibleSection_Id | integer | int64 |\r\n| responsibleStaffMemberId | WorkRequest->ResponsibleStaffMember_Id | integer | int64 |\r\n| workOrderId | WorkRequest->WorkOrder_Id | integer | int64 |\r\n| workRequested | WorkRequest->WorkRequested | string | |\r\n| typeOfWorkId | WorkRequest->TypeOfWork_Id | integer | int64 |\r\n| geographicStartPosition | WorkRequest->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | WorkRequest->GeographicEndPosition | number | decimal |\r\n| geographicLength | WorkRequest->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | WorkRequest->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | WorkRequest->GeographicNotes | string | |\r\n| geographicReferenceEntityType | WorkRequest->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | WorkRequest->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Min Value | > 1| |\r\n| email | Min Length | >= 1 chars| |\r\n| email | Max Length | <= 100 chars| |\r\n| failedComponentId | Nullable | True | WorkRequest->Asset_Id eq null |\r\n| motionType | Nullable | False | |\r\n| phone1 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phone2 | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| requestedOn | Nullable | False | |\r\n| requester | Nullable | False | WorkRequest->RequesterType eq 'FreeText' |\r\n| requester | Min Length | >= 1 chars| WorkRequest->RequesterType eq 'FreeText' |\r\n| requesterType | Nullable | False | |\r\n| workRequested | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateWorkRequest", "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/MatchUpdateWorkRequestResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests/Attributes/{id}": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Get a Work Request 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| workRequestId | WorkRequestAttribute->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestAttribute->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestAttribute->WorkRequest_Description | string | |\r\n| workRequestStatusId | WorkRequestAttribute->WorkRequest_Status_Id | integer | int64 |\r\n| workRequestStatusBaseStatus | WorkRequestAttribute->WorkRequest_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| createdByUserId | WorkRequestAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestAttribute->CreatedOn | string | date-time |\r\n| isActive | WorkRequestAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WorkRequestAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkRequestAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestAttribute->PermissionTree_Description | string | |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| id | WorkRequestAttribute->Id | integer | int64 |\r\n| attributeId | WorkRequestAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkRequestAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkRequestAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WorkRequestAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WorkRequestAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WorkRequestAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WorkRequestAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WorkRequestAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WorkRequestAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WorkRequestAttribute->Notes | string | |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkRequestAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkRequestAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n", "operationId": "GetWorkRequestAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request Attribute", "schema": { "$ref": "#/definitions/GetWorkRequestAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Request Attribute" ], "summary": "Update an existing Work Request 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 | WorkRequestAttribute->Version | integer | int32 |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestAttribute->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": "UpdateWorkRequestAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkRequestAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request Attribute" ], "summary": "Delete an existing Work Request 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 | WorkRequestAttribute->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": "DeleteWorkRequestAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkRequestAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests/{workRequestId}/Attributes": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Get a collection of Work Request Attribute resources for the Work Request.", "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 | WorkRequestAttribute->Id | integer | int64 |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WorkRequestAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkRequestAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkRequestAttribute->Attribute_Description | string | |\r\n| attributeDataType | WorkRequestAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkRequestAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkRequestAttribute->PredefinedValue_Value | object | composite |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n| notes | WorkRequestAttribute->Notes | string | |\r\n| createdOn | WorkRequestAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WorkRequestAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkRequestAttributeCollectionForWorkRequest", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workRequestId", "in": "path", "required": true, "description": "Work Request 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 Work Request Attribute collection", "schema": { "$ref": "#/definitions/GetWorkRequestAttributeCollectionForWorkRequestResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Get a collection of Work Request 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 | WorkRequestAttribute->Id | integer | int64 |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| workRequestId | WorkRequestAttribute->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestAttribute->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestAttribute->WorkRequest_Description | string | |\r\n| workRequestStatusBaseStatus | WorkRequestAttribute->WorkRequest_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | WorkRequestAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkRequestAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkRequestAttribute->Attribute_Description | string | |\r\n| attributeDataType | WorkRequestAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkRequestAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkRequestAttribute->PredefinedValue_Value | object | composite |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n| notes | WorkRequestAttribute->Notes | string | |\r\n| createdOn | WorkRequestAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | WorkRequestAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkRequestAttributeCollection", "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 Work Request Attribute collection", "schema": { "$ref": "#/definitions/GetWorkRequestAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Request Attribute" ], "summary": "Create a new Work Request 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| workRequestId | WorkRequestAttribute->WorkRequest_Id | integer | int64 |\r\n| attributeId | WorkRequestAttribute->Attribute_Id | integer | int64 |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WorkRequestAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestAttribute->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| workRequestId | Required | True | |\r\n| workRequestId | 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": "CreateWorkRequestAttribute", "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/CreateWorkRequestAttributeResourceActionRequest" } }, { "$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/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeAllowedValue": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Work Request 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": "LookupWorkRequestAttributeAllowedValue", "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/WorkRequestAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttribute": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Work Request 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": "LookupWorkRequestAttribute", "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/WorkRequestAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeChangePermissionTree": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Lookup the permission set for changing the Work Request 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": "LookupWorkRequestAttributeChangePermissionTree", "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/WorkRequestAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeInsertPermissionTree": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Lookup the permission set for creating the Work Request 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": "LookupWorkRequestAttributeInsertPermissionTree", "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/WorkRequestAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeWorkRequest": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Lookup the Work Request Attribute for the Work Request 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 | WorkRequest->Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| description | WorkRequest->Description | string | |\r\n", "operationId": "LookupWorkRequestAttributeWorkRequest", "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 Work Request collection", "schema": { "$ref": "#/definitions/WorkRequestAttributeWorkRequestLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes/Batch/{ids}": { "get": { "tags": [ "Work Request Attribute" ], "summary": "Get a collection of Work Request 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| workRequestId | WorkRequestAttribute->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestAttribute->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestAttribute->WorkRequest_Description | string | |\r\n| workRequestStatusId | WorkRequestAttribute->WorkRequest_Status_Id | integer | int64 |\r\n| workRequestStatusBaseStatus | WorkRequestAttribute->WorkRequest_Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| createdByUserId | WorkRequestAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestAttribute->CreatedOn | string | date-time |\r\n| isActive | WorkRequestAttribute->IsActive | boolean | |\r\n| modifiedByUserId | WorkRequestAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkRequestAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestAttribute->PermissionTree_Description | string | |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| id | WorkRequestAttribute->Id | integer | int64 |\r\n| attributeId | WorkRequestAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | WorkRequestAttribute->Attribute_Code | string | |\r\n| attributeDescription | WorkRequestAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | WorkRequestAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | WorkRequestAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | WorkRequestAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | WorkRequestAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | WorkRequestAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | WorkRequestAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | WorkRequestAttribute->Notes | string | |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | WorkRequestAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | WorkRequestAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n", "operationId": "BatchGetWorkRequestAttribute", "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 Work Request 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 Work Request Attribute collection", "schema": { "$ref": "#/definitions/BatchGetWorkRequestAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Attributes/Batch": { "post": { "tags": [ "Work Request Attribute" ], "summary": "Create a new collection of Work Request 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| workRequestId | WorkRequestAttribute->WorkRequest_Id | integer | int64 |\r\n| attributeId | WorkRequestAttribute->Attribute_Id | integer | int64 |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | WorkRequestAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestAttribute->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| workRequestId | Required | True | |\r\n| workRequestId | 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": "BatchCreateWorkRequestAttribute", "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/BatchCreateWorkRequestAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request Attribute" ], "summary": "Update a collection of existing Work Request 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 | WorkRequestAttribute->Id | integer | int64 |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| value | WorkRequestAttribute->Value | object | composite |\r\n| predefinedValueId | WorkRequestAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | WorkRequestAttribute->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestAttribute->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": "BatchUpdateWorkRequestAttribute", "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/BatchUpdateWorkRequestAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request Attribute" ], "summary": "Delete a collection of existing Work Request 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 | WorkRequestAttribute->Id | integer | int64 |\r\n| version | WorkRequestAttribute->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": "BatchDeleteWorkRequestAttribute", "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/BatchDeleteWorkRequestAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests/Attributes/{id}/Active": { "patch": { "tags": [ "Work Request Attribute" ], "summary": "Change the IsActive status for an existing Work Request 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 | WorkRequestAttribute->Version | integer | int32 |\r\n| isActive | WorkRequestAttribute->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": "ChangeWorkRequestAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestAttributeIsActiveResourceActionRequest" } }, { "$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/WM/WorkRequests/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Work Request Attribute" ], "summary": "Change the PermissionTree for an existing Work Request 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 | WorkRequestAttribute->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestAttribute->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": "ChangeWorkRequestAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestAttributePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Work Request Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Work Request 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 | WorkRequestAttribute->Id | integer | int64 |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestAttribute->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": "BatchChangeWorkRequestAttributePermissionTree", "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/BatchChangeWorkRequestAttributePermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/Attributes/Batch/Active": { "patch": { "tags": [ "Work Request Attribute" ], "summary": "Change the IsActive status for a collection of existing Work Request 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 | WorkRequestAttribute->Id | integer | int64 |\r\n| version | WorkRequestAttribute->Version | integer | int32 |\r\n| isActive | WorkRequestAttribute->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": "BatchChangeWorkRequestAttributeIsActive", "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/BatchChangeWorkRequestAttributeIsActiveResourceActionRequest" } }, { "$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/WM/WorkRequests/Documents/{id}": { "get": { "tags": [ "Work Request Document" ], "summary": "Get a Work Request 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| workRequestId | WorkRequestDocument->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestDocument->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestDocument->WorkRequest_Description | string | |\r\n| isActive | WorkRequestDocument->IsActive | boolean | |\r\n| createdByUserId | WorkRequestDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkRequestDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestDocument->ModifiedOn | string | date-time |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestDocument->PermissionTree_Description | string | |\r\n| id | WorkRequestDocument->Id | integer | int64 |\r\n| documentRecordId | WorkRequestDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkRequestDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkRequestDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkRequestDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkRequestDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkRequestDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkRequestDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkRequestDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkRequestDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkRequestDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkRequestDocument->Notes | string | |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWorkRequestDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request Document", "schema": { "$ref": "#/definitions/GetWorkRequestDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Request Document" ], "summary": "Update an existing Work Request 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 | WorkRequestDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestDocument->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": "UpdateWorkRequestDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkRequestDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request Document" ], "summary": "Delete an existing Work Request 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 | WorkRequestDocument->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": "DeleteWorkRequestDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkRequestDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests/{id}/Documents": { "get": { "tags": [ "Work Request Document" ], "summary": "Get a collection of Work Request Document resources for the Work Request.", "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 | WorkRequestDocument->Id | integer | int64 |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkRequestDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkRequestDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkRequestDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkRequestDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkRequestDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkRequestDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkRequestDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetWorkRequestDocumentCollectionForWorkRequest", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request 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 Work Request Document collection", "schema": { "$ref": "#/definitions/GetWorkRequestDocumentCollectionForWorkRequestResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Documents": { "get": { "tags": [ "Work Request Document" ], "summary": "Get a collection of Work Request 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 | WorkRequestDocument->Id | integer | int64 |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| workRequestId | WorkRequestDocument->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestDocument->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestDocument->WorkRequest_Description | string | |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | WorkRequestDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkRequestDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkRequestDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkRequestDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | WorkRequestDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | WorkRequestDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | WorkRequestDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetWorkRequestDocumentCollection", "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 Work Request Document collection", "schema": { "$ref": "#/definitions/GetWorkRequestDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Request Document" ], "summary": "Create a new Work Request 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| workRequestId | WorkRequestDocument->WorkRequest_Id | integer | int64 |\r\n| documentRecordId | WorkRequestDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkRequestDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestDocument->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| workRequestId | Required | True | |\r\n| workRequestId | 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": "CreateWorkRequestDocument", "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/CreateWorkRequestDocumentResourceActionRequest" } }, { "$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/WM/WorkRequests/Documents/Lookups/LookupWorkRequestDocumentChangePermissionTree": { "get": { "tags": [ "Work Request Document" ], "summary": "Lookup the permission set for changing the Work Request 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": "LookupWorkRequestDocumentChangePermissionTree", "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/WorkRequestDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Documents/Lookups/LookupWorkRequestDocument": { "get": { "tags": [ "Work Request Document" ], "summary": "Work Request 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": "LookupWorkRequestDocument", "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/WorkRequestDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Documents/Lookups/LookupWorkRequestDocumentInsertPermissionTree": { "get": { "tags": [ "Work Request Document" ], "summary": "Lookup the permission set for creating the Work Request 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": "LookupWorkRequestDocumentInsertPermissionTree", "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/WorkRequestDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Documents/Lookups/LookupWorkRequestDocumentWorkRequest": { "get": { "tags": [ "Work Request Document" ], "summary": "Lookup the Work Request Document for the Work Request 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 | WorkRequest->Id | integer | int64 |\r\n| code | WorkRequest->Code | string | |\r\n| description | WorkRequest->Description | string | |\r\n", "operationId": "LookupWorkRequestDocumentWorkRequest", "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 Work Request collection", "schema": { "$ref": "#/definitions/WorkRequestDocumentWorkRequestLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Documents/Batch/{ids}": { "get": { "tags": [ "Work Request Document" ], "summary": "Get a collection of Work Request 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| workRequestId | WorkRequestDocument->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestDocument->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestDocument->WorkRequest_Description | string | |\r\n| isActive | WorkRequestDocument->IsActive | boolean | |\r\n| createdByUserId | WorkRequestDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestDocument->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | WorkRequestDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestDocument->ModifiedOn | string | date-time |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestDocument->PermissionTree_Description | string | |\r\n| id | WorkRequestDocument->Id | integer | int64 |\r\n| documentRecordId | WorkRequestDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | WorkRequestDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | WorkRequestDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | WorkRequestDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | WorkRequestDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | WorkRequestDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | WorkRequestDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | WorkRequestDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | WorkRequestDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | WorkRequestDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | WorkRequestDocument->Notes | string | |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWorkRequestDocument", "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 Work Request 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 Work Request Document collection", "schema": { "$ref": "#/definitions/BatchGetWorkRequestDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/Documents/Batch": { "post": { "tags": [ "Work Request Document" ], "summary": "Create a new collection of Work Request 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| workRequestId | WorkRequestDocument->WorkRequest_Id | integer | int64 |\r\n| documentRecordId | WorkRequestDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | WorkRequestDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestDocument->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| workRequestId | Required | True | |\r\n| workRequestId | 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": "BatchCreateWorkRequestDocument", "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/BatchCreateWorkRequestDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request Document" ], "summary": "Update a collection of existing Work Request 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 | WorkRequestDocument->Id | integer | int64 |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| sequenceNumber | WorkRequestDocument->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestDocument->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": "BatchUpdateWorkRequestDocument", "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/BatchUpdateWorkRequestDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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": [ "Work Request Document" ], "summary": "Delete a collection of existing Work Request 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 | WorkRequestDocument->Id | integer | int64 |\r\n| version | WorkRequestDocument->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": "BatchDeleteWorkRequestDocument", "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/BatchDeleteWorkRequestDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request 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/WM/WorkRequests/Documents/{id}/Active": { "patch": { "tags": [ "Work Request Document" ], "summary": "Change the IsActive status for an existing Work Request 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 | WorkRequestDocument->Version | integer | int32 |\r\n| isActive | WorkRequestDocument->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": "ChangeWorkRequestDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkRequests/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Work Request Document" ], "summary": "Change the PermissionTree for an existing Work Request 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 | WorkRequestDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestDocument->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": "ChangeWorkRequestDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Work Request Document" ], "summary": "Change the PermissionTree status for a collection of existing Work Request 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 | WorkRequestDocument->Id | integer | int64 |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestDocument->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": "BatchChangeWorkRequestDocumentPermissionTree", "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/BatchChangeWorkRequestDocumentPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/Documents/Batch/Active": { "patch": { "tags": [ "Work Request Document" ], "summary": "Change the IsActive status for a collection of existing Work Request 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 | WorkRequestDocument->Id | integer | int64 |\r\n| version | WorkRequestDocument->Version | integer | int32 |\r\n| isActive | WorkRequestDocument->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": "BatchChangeWorkRequestDocumentIsActive", "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/BatchChangeWorkRequestDocumentIsActiveResourceActionRequest" } }, { "$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/WM/WorkRequests/FileAttachments/{id}/Download": { "get": { "tags": [ "Work Request File Attachment" ], "summary": "Download the content for a Work Request File Attachment resource.", "description": "", "operationId": "GetWorkRequestFileAttachmentContent", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of attachment content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/{id}": { "get": { "tags": [ "Work Request File Attachment" ], "summary": "Get a Work Request File Attachment 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| workRequestId | WorkRequestFileAttachment->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestFileAttachment->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestFileAttachment->WorkRequest_Description | string | |\r\n| createdByUserId | WorkRequestFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkRequestFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkRequestFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkRequestFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkRequestFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkRequestFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkRequestFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkRequestFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkRequestFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkRequestFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkRequestFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkRequestFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkRequestFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkRequestFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkRequestFileAttachment->FileFullName | string | |\r\n| fileName | WorkRequestFileAttachment->FileName | string | |\r\n| fileTypeId | WorkRequestFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkRequestFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| id | WorkRequestFileAttachment->Id | integer | int64 |\r\n| isActive | WorkRequestFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkRequestFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkRequestFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkRequestFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetWorkRequestFileAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request File Attachment", "schema": { "$ref": "#/definitions/GetWorkRequestFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Request File Attachment" ], "summary": "Update an existing Work Request File Attachment 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 | WorkRequestFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | WorkRequestFileAttachment->FileName | string | |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | 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| fileName | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkRequestFileAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkRequestFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request File Attachment 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": [ "Work Request File Attachment" ], "summary": "Delete an existing Work Request File Attachment 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 | WorkRequestFileAttachment->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": "DeleteWorkRequestFileAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkRequestFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request File Attachment 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/WM/WorkRequests/{id}/FileAttachments": { "get": { "tags": [ "Work Request File Attachment" ], "summary": "Get a collection of Work Request File Attachment resources for the Work Request.", "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 | WorkRequestFileAttachment->Id | integer | int64 |\r\n| version | WorkRequestFileAttachment->Version | integer | int32 |\r\n| fileFullName | WorkRequestFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkRequestFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkRequestFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkRequestFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkRequestFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkRequestFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkRequestFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkRequestFileAttachmentCollectionForWorkRequest", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "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 Work Request File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkRequestFileAttachmentCollectionForWorkRequestResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments": { "get": { "tags": [ "Work Request File Attachment" ], "summary": "Get a collection of Work Request File Attachment 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 | WorkRequestFileAttachment->Id | integer | int64 |\r\n| version | WorkRequestFileAttachment->Version | integer | int32 |\r\n| workRequestId | WorkRequestFileAttachment->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestFileAttachment->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestFileAttachment->WorkRequest_Description | string | |\r\n| fileFullName | WorkRequestFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | WorkRequestFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | WorkRequestFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkRequestFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkRequestFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | WorkRequestFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | WorkRequestFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | WorkRequestFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetWorkRequestFileAttachmentCollection", "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 Work Request File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkRequestFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/Upload": { "post": { "tags": [ "Work Request File Attachment" ], "summary": "Upload and create a new Work Request File Attachment 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| workRequestId | WorkRequestFileAttachment->WorkRequest_Id | integer | int64 |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkRequestFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkRequestFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkRequestFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workRequestId | Required | True | |\r\n| workRequestId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkRequestFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateWorkRequestFileAttachmentResourceActionRequest" } } ], "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" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/{id}/Upload": { "put": { "tags": [ "Work Request File Attachment" ], "summary": "Upload new content for an existing Work Request File Attachment 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 | WorkRequestFileAttachment->Version | integer | int32 |\r\n| bytes | WorkRequestFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateWorkRequestFileAttachmentContent", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkRequestFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Work Request File Attachment" ], "summary": "Get a collection of Work Request File Attachment 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| workRequestId | WorkRequestFileAttachment->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestFileAttachment->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestFileAttachment->WorkRequest_Description | string | |\r\n| createdByUserId | WorkRequestFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestFileAttachment->CreatedOn | string | date-time |\r\n| contentId | WorkRequestFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | WorkRequestFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | WorkRequestFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | WorkRequestFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | WorkRequestFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | WorkRequestFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | WorkRequestFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | WorkRequestFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | WorkRequestFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | WorkRequestFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | WorkRequestFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | WorkRequestFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | WorkRequestFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | WorkRequestFileAttachment->FileFullName | string | |\r\n| fileName | WorkRequestFileAttachment->FileName | string | |\r\n| fileTypeId | WorkRequestFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | WorkRequestFileAttachment->FileType_Extension | string | |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| id | WorkRequestFileAttachment->Id | integer | int64 |\r\n| isActive | WorkRequestFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | WorkRequestFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkRequestFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestFileAttachment->PermissionTree_Description | string | |\r\n| version | WorkRequestFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetWorkRequestFileAttachment", "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 Work Request File Attachment 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 Work Request File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetWorkRequestFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Work Request File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Work Request File Attachment.", "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 | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetWorkRequestFileAttachmentContentHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request File Attachment collection", "schema": { "$ref": "#/definitions/GetWorkRequestFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/Upload/Batch": { "post": { "tags": [ "Work Request File Attachment" ], "summary": "Upload and create a new collection of Work Request File Attachment 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| workRequestId | WorkRequestFileAttachment->WorkRequest_Id | integer | int64 |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkRequestFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | WorkRequestFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | WorkRequestFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| workRequestId | Required | True | |\r\n| workRequestId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkRequestFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateWorkRequestFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Request File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/FileAttachments/Batch": { "patch": { "tags": [ "Work Request File Attachment" ], "summary": "Update a collection of existing Work Request File Attachment 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 | WorkRequestFileAttachment->Id | integer | int64 |\r\n| version | WorkRequestFileAttachment->Version | integer | int32 |\r\n| isRestricted | WorkRequestFileAttachment->IsRestricted | boolean | |\r\n| fileName | WorkRequestFileAttachment->FileName | string | |\r\n| fileCategoryId | WorkRequestFileAttachment->FileCategory_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| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateWorkRequestFileAttachment", "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/BatchUpdateWorkRequestFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request File Attachment 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": [ "Work Request File Attachment" ], "summary": "Delete a collection of existing Work Request File Attachment 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 | WorkRequestFileAttachment->Id | integer | int64 |\r\n| version | WorkRequestFileAttachment->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": "BatchDeleteWorkRequestFileAttachment", "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/BatchDeleteWorkRequestFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request File Attachment 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/WM/WorkRequestStatuses/{id}": { "get": { "tags": [ "Work Request Status" ], "summary": "Get a Work Request Status 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 | WorkRequestStatus->Code | string | |\r\n| createdByUserId | WorkRequestStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestStatus->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestStatus->CreatedOn | string | date-time |\r\n| isActive | WorkRequestStatus->IsActive | boolean | |\r\n| modifiedByUserId | WorkRequestStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestStatus->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkRequestStatus->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestStatus->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestStatus->PermissionTree_Description | string | |\r\n| id | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->Version | integer | int32 |\r\n| description | WorkRequestStatus->Description | string | |\r\n| notes | WorkRequestStatus->Notes | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkRequestStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n", "operationId": "GetWorkRequestStatus", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Status Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request Status", "schema": { "$ref": "#/definitions/GetWorkRequestStatusResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Work Request Status" ], "summary": "Update an existing Work Request Status 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 | WorkRequestStatus->Version | integer | int32 |\r\n| code | WorkRequestStatus->Code | string | |\r\n| description | WorkRequestStatus->Description | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestStatus->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": "UpdateWorkRequestStatus", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Status Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWorkRequestStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request Status 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": [ "Work Request Status" ], "summary": "Delete an existing Work Request Status 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 | WorkRequestStatus->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": "DeleteWorkRequestStatus", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Status Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWorkRequestStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request Status 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/WM/WorkRequestStatuses": { "get": { "tags": [ "Work Request Status" ], "summary": "Get a collection of Work Request Status 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 | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->Version | integer | int32 |\r\n| code | WorkRequestStatus->Code | string | |\r\n| description | WorkRequestStatus->Description | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkRequestStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| isActive | WorkRequestStatus->IsActive | boolean | |\r\n", "operationId": "GetWorkRequestStatusCollection", "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 Work Request Status collection", "schema": { "$ref": "#/definitions/GetWorkRequestStatusCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Work Request Status" ], "summary": "Create a new Work Request Status 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 | WorkRequestStatus->PermissionTree_Id | integer | int64 |\r\n| code | WorkRequestStatus->Code | string | |\r\n| description | WorkRequestStatus->Description | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkRequestStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n| notes | WorkRequestStatus->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| baseStatus | Required | True | |\r\n| baseStatus | Nullable | False | |\r\n\r\n", "operationId": "CreateWorkRequestStatus", "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/CreateWorkRequestStatusResourceActionRequest" } }, { "$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/WM/WorkRequestStatuses/Lookups/LookupWorkRequestStatusChangePermissionTree": { "get": { "tags": [ "Work Request Status" ], "summary": "Lookup the permission set for changing the Work Request Status.", "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": "LookupWorkRequestStatusChangePermissionTree", "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/WorkRequestStatusChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequestStatuses/Lookups/LookupWorkRequestStatusInsertPermissionTree": { "get": { "tags": [ "Work Request Status" ], "summary": "Lookup the permission set for creating the Work Request Status.", "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": "LookupWorkRequestStatusInsertPermissionTree", "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/WorkRequestStatusInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequestStatuses/Batch/{ids}": { "get": { "tags": [ "Work Request Status" ], "summary": "Get a collection of Work Request Status 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 | WorkRequestStatus->Code | string | |\r\n| createdByUserId | WorkRequestStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestStatus->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestStatus->CreatedOn | string | date-time |\r\n| isActive | WorkRequestStatus->IsActive | boolean | |\r\n| modifiedByUserId | WorkRequestStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WorkRequestStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WorkRequestStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WorkRequestStatus->ModifiedOn | string | date-time |\r\n| permissionTreeId | WorkRequestStatus->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WorkRequestStatus->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WorkRequestStatus->PermissionTree_Description | string | |\r\n| id | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->Version | integer | int32 |\r\n| description | WorkRequestStatus->Description | string | |\r\n| notes | WorkRequestStatus->Notes | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkRequestStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | enum |\r\n", "operationId": "BatchGetWorkRequestStatus", "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 Work Request Status 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 Work Request Status collection", "schema": { "$ref": "#/definitions/BatchGetWorkRequestStatusResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequestStatuses/Batch": { "post": { "tags": [ "Work Request Status" ], "summary": "Create a new collection of Work Request Status 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 | WorkRequestStatus->PermissionTree_Id | integer | int64 |\r\n| code | WorkRequestStatus->Code | string | |\r\n| description | WorkRequestStatus->Description | string | |\r\n| notes | WorkRequestStatus->Notes | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| baseStatus | WorkRequestStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Closed, Cancelled]) | 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| 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| baseStatus | Required | True | |\r\n| baseStatus | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateWorkRequestStatus", "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/BatchCreateWorkRequestStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Work Request Status 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": [ "Work Request Status" ], "summary": "Update a collection of existing Work Request Status 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 | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->Version | integer | int32 |\r\n| code | WorkRequestStatus->Code | string | |\r\n| description | WorkRequestStatus->Description | string | |\r\n| sequenceNumber | WorkRequestStatus->SequenceNumber | integer | int32 |\r\n| notes | WorkRequestStatus->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": "BatchUpdateWorkRequestStatus", "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/BatchUpdateWorkRequestStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request Status 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": [ "Work Request Status" ], "summary": "Delete a collection of existing Work Request Status 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 | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->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": "BatchDeleteWorkRequestStatus", "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/BatchDeleteWorkRequestStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Work Request Status 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/WM/WorkRequestStatuses/{id}/Active": { "patch": { "tags": [ "Work Request Status" ], "summary": "Change the IsActive status for an existing Work Request Status 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 | WorkRequestStatus->Version | integer | int32 |\r\n| isActive | WorkRequestStatus->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": "ChangeWorkRequestStatusIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Status Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestStatusIsActiveResourceActionRequest" } }, { "$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/WM/WorkRequestStatuses/{id}/PermissionTree": { "patch": { "tags": [ "Work Request Status" ], "summary": "Change the PermissionTree for an existing Work Request Status 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 | WorkRequestStatus->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestStatus->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": "ChangeWorkRequestStatusPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Status Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWorkRequestStatusPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequestStatuses/Batch/Active": { "patch": { "tags": [ "Work Request Status" ], "summary": "Change the IsActive status for a collection of existing Work Request Status 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 | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->Version | integer | int32 |\r\n| isActive | WorkRequestStatus->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": "BatchChangeWorkRequestStatusIsActive", "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/BatchChangeWorkRequestStatusIsActiveResourceActionRequest" } }, { "$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/WM/WorkRequestStatuses/Batch/PermissionTree": { "patch": { "tags": [ "Work Request Status" ], "summary": "Change the PermissionTree status for a collection of existing Work Request Status 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 | WorkRequestStatus->Id | integer | int64 |\r\n| version | WorkRequestStatus->Version | integer | int32 |\r\n| permissionTreeId | WorkRequestStatus->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": "BatchChangeWorkRequestStatusPermissionTree", "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/BatchChangeWorkRequestStatusPermissionTreeResourceActionRequest" } }, { "$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/WM/WorkRequests/StatusChangeHistory/{id}": { "get": { "tags": [ "Work Request Status Change History" ], "summary": "Get a Work Request Status Change History 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 | WorkRequestStatusChangeHistory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestStatusChangeHistory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestStatusChangeHistory->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestStatusChangeHistory->CreatedOn | string | date-time |\r\n| id | WorkRequestStatusChangeHistory->Id | integer | int64 |\r\n| version | WorkRequestStatusChangeHistory->Version | integer | int32 |\r\n| elapsedTime | WorkRequestStatusChangeHistory->ElapsedTime | string | duration |\r\n| statusChangedOn | WorkRequestStatusChangeHistory->StatusChangedOn | string | date-time |\r\n| isLatest | WorkRequestStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkRequestStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkRequestStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkRequestStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | WorkRequestStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkRequestStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkRequestStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkRequestStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| remark | WorkRequestStatusChangeHistory->Remark | string | |\r\n| workRequestId | WorkRequestStatusChangeHistory->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestStatusChangeHistory->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestStatusChangeHistory->WorkRequest_Description | string | |\r\n| workRequestWorkRequested | WorkRequestStatusChangeHistory->WorkRequest_WorkRequested | string | |\r\n", "operationId": "GetWorkRequestStatusChangeHistory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Work Request Status Change History Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Work Request Status Change History", "schema": { "$ref": "#/definitions/GetWorkRequestStatusChangeHistoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/StatusChangeHistory": { "get": { "tags": [ "Work Request Status Change History" ], "summary": "Get a collection of Work Request Status Change History 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 | WorkRequestStatusChangeHistory->Id | integer | int64 |\r\n| elapsedTime | WorkRequestStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | WorkRequestStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkRequestStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkRequestStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkRequestStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | WorkRequestStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkRequestStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkRequestStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkRequestStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorWorkRequestCode | WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Code | string | |\r\n| predecessorWorkRequestDescription | WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Description | string | |\r\n| remark | WorkRequestStatusChangeHistory->Remark | string | |\r\n| createdOn | WorkRequestStatusChangeHistory->CreatedOn | string | date-time |\r\n| createdByUserCode | WorkRequestStatusChangeHistory->CreatedByUser_Code | string | |\r\n| workRequestId | WorkRequestStatusChangeHistory->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestStatusChangeHistory->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestStatusChangeHistory->WorkRequest_Description | string | |\r\n| workRequestPermissionTreeCode | WorkRequestStatusChangeHistory->WorkRequest_PermissionTree_Code | string | |\r\n| workRequestPermissionTreeDescription | WorkRequestStatusChangeHistory->WorkRequest_PermissionTree_Description | string | |\r\n| workRequestSiteCode | WorkRequestStatusChangeHistory->WorkRequest_Site_Code | string | |\r\n| workRequestSiteDescription | WorkRequestStatusChangeHistory->WorkRequest_Site_Description | string | |\r\n", "operationId": "GetWorkRequestStatusChangeHistoryCollection", "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 Work Request Status Change History collection", "schema": { "$ref": "#/definitions/GetWorkRequestStatusChangeHistoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/{workRequestId}/StatusChangeHistory": { "get": { "tags": [ "Work Request Status Change History" ], "summary": "Get a collection of Work Request Status Change History resources for the Work Request.", "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 | WorkRequestStatusChangeHistory->Id | integer | int64 |\r\n| elapsedTime | WorkRequestStatusChangeHistory->ElapsedTime | string | duration |\r\n| isLatest | WorkRequestStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkRequestStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkRequestStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkRequestStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | WorkRequestStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkRequestStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkRequestStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkRequestStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| predecessorWorkRequestCode | WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Code | string | |\r\n| predecessorWorkRequestDescription | WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Description | string | |\r\n| remark | WorkRequestStatusChangeHistory->Remark | string | |\r\n| createdOn | WorkRequestStatusChangeHistory->CreatedOn | string | date-time |\r\n| createdByUserCode | WorkRequestStatusChangeHistory->CreatedByUser_Code | string | |\r\n", "operationId": "GetWorkRequestStatusChangeHistoryCollectionForWorkRequestCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "workRequestId", "in": "path", "required": true, "description": "Work Request 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 Work Request Status Change History collection", "schema": { "$ref": "#/definitions/GetWorkRequestStatusChangeHistoryCollectionForWorkRequestResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/WM/WorkRequests/StatusChangeHistory/Batch/{ids}": { "get": { "tags": [ "Work Request Status Change History" ], "summary": "Get a collection of Work Request Status Change History 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 | WorkRequestStatusChangeHistory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WorkRequestStatusChangeHistory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WorkRequestStatusChangeHistory->CreatedByUser_FullName | string | |\r\n| createdOn | WorkRequestStatusChangeHistory->CreatedOn | string | date-time |\r\n| id | WorkRequestStatusChangeHistory->Id | integer | int64 |\r\n| version | WorkRequestStatusChangeHistory->Version | integer | int32 |\r\n| elapsedTime | WorkRequestStatusChangeHistory->ElapsedTime | string | duration |\r\n| statusChangedOn | WorkRequestStatusChangeHistory->StatusChangedOn | string | date-time |\r\n| isLatest | WorkRequestStatusChangeHistory->IsLatest | boolean | |\r\n| newStatusId | WorkRequestStatusChangeHistory->NewStatus_Id | integer | int64 |\r\n| newStatusCode | WorkRequestStatusChangeHistory->NewStatus_Code | string | |\r\n| newStatusDescription | WorkRequestStatusChangeHistory->NewStatus_Description | string | |\r\n| oldStatusId | WorkRequestStatusChangeHistory->OldStatus_Id | integer | int64 |\r\n| oldStatusCode | WorkRequestStatusChangeHistory->OldStatus_Code | string | |\r\n| oldStatusDescription | WorkRequestStatusChangeHistory->OldStatus_Description | string | |\r\n| predecessorId | WorkRequestStatusChangeHistory->Predecessor_Id | integer | int64 |\r\n| remark | WorkRequestStatusChangeHistory->Remark | string | |\r\n| workRequestId | WorkRequestStatusChangeHistory->WorkRequest_Id | integer | int64 |\r\n| workRequestCode | WorkRequestStatusChangeHistory->WorkRequest_Code | string | |\r\n| workRequestDescription | WorkRequestStatusChangeHistory->WorkRequest_Description | string | |\r\n| workRequestWorkRequested | WorkRequestStatusChangeHistory->WorkRequest_WorkRequested | string | |\r\n", "operationId": "BatchGetWorkRequestStatusChangeHistory", "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 Work Request Status Change History 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 Work Request Status Change History collection", "schema": { "$ref": "#/definitions/BatchGetWorkRequestStatusChangeHistoryResourceAction" } }, "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" ] }, "GetDueTaskResourceActionResponse": { "title": "GetDueTaskResourceActionResponse", "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": "GetDueTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->Asset_Description" }, "defaultIntervalId": { "title": "defaultIntervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTask->DefaultInterval_Id" }, "defaultIntervalCode": { "title": "defaultIntervalCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->DefaultInterval_Code" }, "defaultIntervalDescription": { "title": "defaultIntervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->DefaultInterval_Description" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "DueTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DueTask->DueReading" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTask->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->Event_Description" }, "generatedOn": { "title": "generatedOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "DueTask->GeneratedOn" }, "interval1DueDate": { "title": "interval1DueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTask->Interval1DueDate" }, "interval2DueDate": { "title": "interval2DueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTask->Interval2DueDate" }, "intervalTypeId": { "title": "intervalTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTask->IntervalType_Id" }, "intervalTypeCode": { "title": "intervalTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->IntervalType_Code" }, "intervalTypeDescription": { "title": "intervalTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->IntervalType_Description" }, "intervalTypeSchedulingKind": { "title": "intervalTypeSchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DueTask->IntervalType_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->IsSuppressed" }, "outOfBoundsTask": { "title": "outOfBoundsTask", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->OutOfBoundsTask" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DueTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->RegularAssetTask_Description" }, "regularAssetTaskIsActive": { "title": "regularAssetTaskIsActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->RegularAssetTask_IsActive" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DueTask->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "suppressionType": { "title": "suppressionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DueTask->SuppressionType", "x-formatSpecifier": "DueTaskSuppressionType" }, "usedActualInterval": { "title": "usedActualInterval", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DueTask->UsedActualInterval" } } }, "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" } } }, "GetDueTaskCollectionResourceActionResponse": { "title": "GetDueTaskCollectionResourceActionResponse", "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": "GetDueTaskCollectionResourceActionResponseItem", "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": "GetDueTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "generatedOn": { "title": "generatedOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "DueTask->GeneratedOn" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "DueTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DueTask->DueReading" }, "interval1DueDate": { "title": "interval1DueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTask->Interval1DueDate" }, "interval2DueDate": { "title": "interval2DueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTask->Interval2DueDate" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->IsSuppressed" }, "suppressionType": { "title": "suppressionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DueTask->SuppressionType", "x-formatSpecifier": "DueTaskSuppressionType" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTask->Asset_Code" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "DueTask->RegularAssetTask_Code" }, "outOfBoundsTask": { "title": "outOfBoundsTask", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->OutOfBoundsTask" } } }, "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" } } } }, "DeleteDueTaskResourceActionRequest": { "title": "DeleteDueTaskResourceActionRequest", "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 } } }, "BatchGetDueTaskResourceAction": { "title": "BatchGetDueTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Due Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Due Task entities", "items": { "$ref": "#/definitions/GetDueTaskResourceActionResponse" } }, "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" } } }, "BatchDeleteDueTaskResourceActionRequest": { "title": "BatchDeleteDueTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDueTaskResourceActionRequest" } }, "GetDueTaskSuppressorResourceActionResponse": { "title": "GetDueTaskSuppressorResourceActionResponse", "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": "GetDueTaskSuppressorResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DueTaskSuppressor->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DueTaskSuppressor->ModifiedOn" }, "suppressedDueTaskId": { "title": "suppressedDueTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_Id" }, "suppressedDueTaskRegularAssetTaskId": { "title": "suppressedDueTaskRegularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Id" }, "suppressedDueTaskRegularAssetTaskCode": { "title": "suppressedDueTaskRegularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Code" }, "suppressedDueTaskRegularAssetTaskDescription": { "title": "suppressedDueTaskRegularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description" }, "suppressedFrom": { "title": "suppressedFrom", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTaskSuppressor->SuppressedFrom" }, "suppressedTo": { "title": "suppressedTo", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTaskSuppressor->SuppressedTo" }, "suppressionType": { "title": "suppressionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressionType", "x-formatSpecifier": "DueTaskSuppressionType" }, "suppressorDueTaskId": { "title": "suppressorDueTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_Id" }, "suppressorDueTaskRegularAssetTaskId": { "title": "suppressorDueTaskRegularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Id" }, "suppressorDueTaskRegularAssetTaskCode": { "title": "suppressorDueTaskRegularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Code" }, "suppressorDueTaskRegularAssetTaskDescription": { "title": "suppressorDueTaskRegularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_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" } } }, "GetDueTaskSuppressorCollectionResourceActionResponse": { "title": "GetDueTaskSuppressorCollectionResourceActionResponse", "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": "GetDueTaskSuppressorCollectionResourceActionResponseItem", "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": "GetDueTaskSuppressorCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "suppressedDueTaskId": { "title": "suppressedDueTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_Id" }, "suppressedDueTaskRegularAssetTaskDescription": { "title": "suppressedDueTaskRegularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description" }, "suppressedFrom": { "title": "suppressedFrom", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTaskSuppressor->SuppressedFrom" }, "suppressedTo": { "title": "suppressedTo", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTaskSuppressor->SuppressedTo" }, "suppressorDueTaskId": { "title": "suppressorDueTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_Id" }, "suppressorDueTaskRegularAssetTaskDescription": { "title": "suppressorDueTaskRegularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DueTaskSuppressor->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DueTaskSuppressor->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" } } } }, "GeDueTaskSuppressorForCollectionDueTaskResourceActionResponse": { "title": "GeDueTaskSuppressorForCollectionDueTaskResourceActionResponse", "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": "GeDueTaskSuppressorForCollectionDueTaskResourceActionResponseItem", "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": "GeDueTaskSuppressorForCollectionDueTaskResourceActionResponseItemProperties", "type": "object", "properties": { "suppressedDueTaskId": { "title": "suppressedDueTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_Id" }, "suppressedDueTaskRegularAssetTaskDescription": { "title": "suppressedDueTaskRegularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DueTaskSuppressor->SuppressedDueTask_RegularAssetTask_Description" }, "suppressedFrom": { "title": "suppressedFrom", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTaskSuppressor->SuppressedFrom" }, "suppressedTo": { "title": "suppressedTo", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTaskSuppressor->SuppressedTo" }, "suppressorDueTaskId": { "title": "suppressorDueTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_Id" }, "suppressorDueTaskRegularAssetTaskDescription": { "title": "suppressorDueTaskRegularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DueTaskSuppressor->SuppressorDueTask_RegularAssetTask_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DueTaskSuppressor->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DueTaskSuppressor->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" } } } }, "BatchGetDueTaskSuppressorResourceAction": { "title": "BatchGetDueTaskSuppressorResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Due Task Suppressor entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Due Task Suppressor entities", "items": { "$ref": "#/definitions/GetDueTaskSuppressorResourceActionResponse" } }, "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" } } }, "GetGenerateProposedWorkOrdersSystemOptionDefaultsResourceActionResponse": { "title": "GetGenerateProposedWorkOrdersSystemOptionDefaultsResourceActionResponse", "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": "GetGenerateProposedWorkOrdersSystemOptionDefaultsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "proposedWorkOrdersFutureRange": { "title": "proposedWorkOrdersFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilterDefaultSystemOptionValues->ProposedWorkOrdersFutureRange" }, "proposedWorkDefaultGroupingInterval": { "title": "proposedWorkDefaultGroupingInterval", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilterDefaultSystemOptionValues->ProposedWorkDefaultGroupingInterval" }, "proposedWorkDefaultTaskGroupingStartDate": { "title": "proposedWorkDefaultTaskGroupingStartDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GenerateProposedWorkOrdersFilterDefaultSystemOptionValues->ProposedWorkDefaultTaskGroupingStartDate" } } }, "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" } } }, "GetGenerateWorkOrdersSystemOptionDefaultsResourceActionResponse": { "title": "GetGenerateWorkOrdersSystemOptionDefaultsResourceActionResponse", "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": "GetGenerateWorkOrdersSystemOptionDefaultsResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "combineResourcesOnSingleTask": { "title": "combineResourcesOnSingleTask", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "GenerateWorkOrdersDefaultSystemOptionValues->CombineResourcesOnSingleTask", "x-formatSpecifier": "SystemOptionGenerateWorkOrderCombineResourcesOnSingleTask" } } }, "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" } } }, "GetProposedWorkOrderResourceActionResponse": { "title": "GetProposedWorkOrderResourceActionResponse", "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": "GetProposedWorkOrderResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrder->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrder->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Site_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Asset_Description" }, "defaultIntervalId": { "title": "defaultIntervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->DefaultInterval_Id" }, "defaultIntervalCode": { "title": "defaultIntervalCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->DefaultInterval_Code" }, "defaultIntervalDescription": { "title": "defaultIntervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->DefaultInterval_Description" }, "defaultIntervalTaskIntervalTypeId": { "title": "defaultIntervalTaskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->DefaultInterval_TaskIntervalType_Id" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Description" }, "downtime": { "title": "downtime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ProposedWorkOrder->Downtime" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrder->DueDate" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ProposedWorkOrder->Duration" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->Event_Description" }, "intervalTypeId": { "title": "intervalTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->IntervalType_Id" }, "intervalTypeCode": { "title": "intervalTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->IntervalType_Code" }, "intervalTypeDescription": { "title": "intervalTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->IntervalType_Description" }, "intervalTypeSchedulingKind": { "title": "intervalTypeSchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->IntervalType_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->MachineState", "x-formatSpecifier": "MachineState" }, "mainScheduledReading": { "title": "mainScheduledReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->MainScheduledReading" }, "minStartDate": { "title": "minStartDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrder->MinStartDate" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->MotionType", "x-formatSpecifier": "MotionType" }, "proposedWorkOrderBatchId": { "title": "proposedWorkOrderBatchId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ProposedWorkOrderBatch_Id" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceDescription": { "title": "responsibleStaffMemberResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_Description" }, "responsibleStaffMemberResourceResourceType": { "title": "responsibleStaffMemberResourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_ResourceType", "x-formatSpecifier": "ResourceType" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleStaffMemberResourceContactDetailDepartment": { "title": "responsibleStaffMemberResourceContactDetailDepartment", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailDepartment" }, "responsibleStaffMemberResourceContactDetailJobTitle": { "title": "responsibleStaffMemberResourceContactDetailJobTitle", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_ContactDetailJobTitle" }, "responsibleStaffMemberResourceSiteId": { "title": "responsibleStaffMemberResourceSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Id" }, "responsibleStaffMemberResourceSiteCode": { "title": "responsibleStaffMemberResourceSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Code" }, "responsibleStaffMemberResourceSiteDescription": { "title": "responsibleStaffMemberResourceSiteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleStaffMemberResource_Site_Description" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ResponsibleTrade_Description" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Status", "x-formatSpecifier": "ProposedWorkOrderStatus" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TaskClassification8_Description" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkType": { "title": "typeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->WorkOrder_Description" }, "workOrderGeneratedOn": { "title": "workOrderGeneratedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrder->WorkOrderGeneratedOn" }, "workOrderGenerationMessage": { "title": "workOrderGenerationMessage", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->WorkOrderGenerationMessage" } } }, "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" } } }, "GetProposedWorkOrderBatchCollectionResourceActionResponse": { "title": "GetProposedWorkOrderBatchCollectionResourceActionResponse", "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": "GetProposedWorkOrderBatchCollectionResourceActionResponseItem", "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": "GetProposedWorkOrderBatchCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderBatch->Name" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderBatch->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderBatch->CreatedOn" } } }, "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" } } } }, "GetProposedWorkOrderCollectionResourceActionResponse": { "title": "GetProposedWorkOrderCollectionResourceActionResponse", "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": "GetProposedWorkOrderCollectionResourceActionResponseItem", "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": "GetProposedWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Status", "x-formatSpecifier": "ProposedWorkOrderStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Asset_Description" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrder->DueDate" }, "mainScheduledReading": { "title": "mainScheduledReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->MainScheduledReading" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->WorkOrder_Code" }, "workOrderGeneratedOn": { "title": "workOrderGeneratedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrder->WorkOrderGeneratedOn" }, "workOrderGenerationMessage": { "title": "workOrderGenerationMessage", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->WorkOrderGenerationMessage" }, "proposedWorkOrderBatchId": { "title": "proposedWorkOrderBatchId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ProposedWorkOrderBatch_Id" }, "proposedWorkOrderBatchName": { "title": "proposedWorkOrderBatchName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrder->ProposedWorkOrderBatch_Name" }, "proposedWorkOrderBatchCreatedOn": { "title": "proposedWorkOrderBatchCreatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrder->ProposedWorkOrderBatch_CreatedOn" }, "proposedWorkOrderBatchCreatedByUserCode": { "title": "proposedWorkOrderBatchCreatedByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrder->ProposedWorkOrderBatch_CreatedByUser_Code" } } }, "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" } } } }, "ProposedWorkOrderBatchLookupResourceActionResponse": { "title": "ProposedWorkOrderBatchLookupResourceActionResponse", "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": "ProposedWorkOrderBatchLookupResourceActionResponseItem", "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": "ProposedWorkOrderBatchLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderBatch->Name" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderBatch->CreatedByUser_Code" } } }, "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" } } } }, "ProposedWorkOrderEventLookupResourceActionResponse": { "title": "ProposedWorkOrderEventLookupResourceActionResponse", "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": "ProposedWorkOrderEventLookupResourceActionResponseItem", "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": "ProposedWorkOrderEventLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Event->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" } } } }, "ProposedWorkOrderIntervalTypeLookupResourceActionResponse": { "title": "ProposedWorkOrderIntervalTypeLookupResourceActionResponse", "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": "ProposedWorkOrderIntervalTypeLookupResourceActionResponseItem", "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": "ProposedWorkOrderIntervalTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->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" } } } }, "ProposedWorkOrderLocationLookupResourceActionResponse": { "title": "ProposedWorkOrderLocationLookupResourceActionResponse", "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": "ProposedWorkOrderLocationLookupResourceActionResponseItem", "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": "ProposedWorkOrderLocationLookupResourceActionResponseItemProperties", "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" } } } }, "ProposedWorkOrderRegularAssetLookupResourceActionResponse": { "title": "ProposedWorkOrderRegularAssetLookupResourceActionResponse", "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": "ProposedWorkOrderRegularAssetLookupResourceActionResponseItem", "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": "ProposedWorkOrderRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->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" } } } }, "ProposedWorkOrderRegularAssetTypeLookupResourceActionResponse": { "title": "ProposedWorkOrderRegularAssetTypeLookupResourceActionResponse", "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": "ProposedWorkOrderRegularAssetTypeLookupResourceActionResponseItem", "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": "ProposedWorkOrderRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->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" } } } }, "ProposedWorkOrderSiteLookupResourceActionResponse": { "title": "ProposedWorkOrderSiteLookupResourceActionResponse", "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": "ProposedWorkOrderSiteLookupResourceActionResponseItem", "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": "ProposedWorkOrderSiteLookupResourceActionResponseItemProperties", "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" } } } }, "ProposedWorkOrderTaskClassification1LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification1LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification1LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification2LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification2LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification2LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification3LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification3LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification3LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification3LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification4LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification4LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification4LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification4LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification5LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification5LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification5LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification5LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification6LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification6LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification6LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification6LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification7LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification7LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification7LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification7LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ProposedWorkOrderTaskClassification8LookupResourceActionResponse": { "title": "ProposedWorkOrderTaskClassification8LookupResourceActionResponse", "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": "ProposedWorkOrderTaskClassification8LookupResourceActionResponseItem", "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": "ProposedWorkOrderTaskClassification8LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "DeleteProposedWorkOrderBatchResourceActionRequest": { "title": "DeleteProposedWorkOrderBatchResourceActionRequest", "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 } } }, "DeleteProposedWorkOrderResourceActionRequest": { "title": "DeleteProposedWorkOrderResourceActionRequest", "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 } } }, "BatchGetProposedWorkOrderResourceAction": { "title": "BatchGetProposedWorkOrderResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Proposed Work Order entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Proposed Work Order entities", "items": { "$ref": "#/definitions/GetProposedWorkOrderResourceActionResponse" } }, "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" } } }, "BatchDeleteProposedWorkOrderBatchResourceActionRequest": { "title": "BatchDeleteProposedWorkOrderBatchResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteProposedWorkOrderResourceActionRequest" } }, "BatchDeleteProposedWorkOrderResourceActionRequest": { "title": "BatchDeleteProposedWorkOrderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteProposedWorkOrderResourceActionRequest" } }, "DeleteProposedWorkOrdersResourceActionRequest": { "title": "DeleteProposedWorkOrdersResourceActionRequest", "type": "object", "properties": { "properties": { "title": "DeleteProposedWorkOrdersResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "deleteAll": { "title": "deleteAll", "type": "boolean", "x-nullable": true, "x-propertyPath": "DeleteProposedWorkOrdersFilter->DeleteAll" }, "proposedWorkOrderBatchId": { "title": "proposedWorkOrderBatchId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DeleteProposedWorkOrdersFilter->ProposedWorkOrderBatch_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GenerateProposedWorkOrdersResourceActionRequest": { "title": "GenerateProposedWorkOrdersResourceActionRequest", "type": "object", "properties": { "properties": { "title": "GenerateProposedWorkOrdersResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->Site_Id" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->AssetType_Id" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->Asset_Id" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->Event_Id" }, "taskIntervalTypeId": { "title": "taskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->TaskIntervalType_Id" }, "combineMeters": { "title": "combineMeters", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->CombineMeters" }, "combineMonitoringPoints": { "title": "combineMonitoringPoints", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->CombineMonitoringPoints" }, "combineCalendarAndUsageBasedTasks": { "title": "combineCalendarAndUsageBasedTasks", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->CombineCalendarAndUsageBasedTasks" }, "combineLastDoneLastScheduledTasks": { "title": "combineLastDoneLastScheduledTasks", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->CombineLastDoneLastScheduledTasks" }, "taskSchedulingMethod": { "title": "taskSchedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->TaskSchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "splitResponsibleTrades": { "title": "splitResponsibleTrades", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitResponsibleTrades" }, "splitResponsibleSections": { "title": "splitResponsibleSections", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitResponsibleSections" }, "splitResponsibleStaff": { "title": "splitResponsibleStaff", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitResponsibleStaff" }, "splitIntervalType": { "title": "splitIntervalType", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitIntervalType" }, "splitMotionType": { "title": "splitMotionType", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitMotionType" }, "splitMachineState": { "title": "splitMachineState", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitMachineState" }, "splitDefaultInterval": { "title": "splitDefaultInterval", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitDefaultInterval" }, "splitTypeOfWork": { "title": "splitTypeOfWork", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTypeOfWork" }, "splitTaskClassification1": { "title": "splitTaskClassification1", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification1" }, "splitTaskClassification2": { "title": "splitTaskClassification2", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification2" }, "splitTaskClassification3": { "title": "splitTaskClassification3", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification3" }, "splitTaskClassification4": { "title": "splitTaskClassification4", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification4" }, "splitTaskClassification5": { "title": "splitTaskClassification5", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification5" }, "splitTaskClassification6": { "title": "splitTaskClassification6", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification6" }, "splitTaskClassification7": { "title": "splitTaskClassification7", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification7" }, "splitTaskClassification8": { "title": "splitTaskClassification8", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->SplitTaskClassification8" }, "groupingInterval": { "title": "groupingInterval", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->GroupingInterval" }, "futureRange": { "title": "futureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->FutureRange" }, "groupingIntervalStartDate": { "title": "groupingIntervalStartDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "GenerateProposedWorkOrdersFilter->GroupingIntervalStartDate" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->Location_Id" }, "proposedWorkOrdersAsset": { "title": "proposedWorkOrdersAsset", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "GenerateProposedWorkOrdersFilter->ProposedWorkOrdersAsset", "x-formatSpecifier": "ProposedWorkOrdersAsset" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GenerateWorkOrdersFromProposedWorkOrdersResourceActionRequest": { "title": "GenerateWorkOrdersFromProposedWorkOrdersResourceActionRequest", "type": "object", "properties": { "properties": { "title": "GenerateWorkOrdersFromProposedWorkOrdersResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "proposedWorkOrderIds": { "title": "proposedWorkOrderIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "GenerateWorkOrdersFromProposedWorkOrders->ProposedWorkOrderIds", "x-formatSpecifier": "Int64" }, "combineResourcesOnSingleWorkOrderTask": { "title": "combineResourcesOnSingleWorkOrderTask", "type": "boolean", "x-nullable": true, "x-propertyPath": "GenerateWorkOrdersFromProposedWorkOrders->CombineResourcesOnSingleWorkOrderTask" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GetProposedWorkOrderMeterResourceActionResponse": { "title": "GetProposedWorkOrderMeterResourceActionResponse", "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": "GetProposedWorkOrderMeterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderMeter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderMeter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderMeter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->PermissionTree_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Code" }, "meterLastReading": { "title": "meterLastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_LastReading" }, "meterAverageDailyRate": { "title": "meterAverageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_AverageDailyRate" }, "meterCumulativeReading": { "title": "meterCumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_CumulativeReading" }, "meterLastReadOn": { "title": "meterLastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderMeter->Meter_LastReadOn" }, "meterNotes": { "title": "meterNotes", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Notes" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Description" }, "proposedWorkOrderId": { "title": "proposedWorkOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderMeter->ProposedWorkOrder_Id" }, "proposedWorkOrderDescription": { "title": "proposedWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ProposedWorkOrder_Description" }, "proposedWorkOrderTaskId": { "title": "proposedWorkOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ProposedWorkOrderTask_Id" }, "scheduledDate": { "title": "scheduledDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrderMeter->ScheduledDate" }, "scheduledMeterReading": { "title": "scheduledMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ScheduledMeterReading" } } }, "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" } } }, "GetProposedWorkOrderMeterCollectionResourceActionResponse": { "title": "GetProposedWorkOrderMeterCollectionResourceActionResponse", "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": "GetProposedWorkOrderMeterCollectionResourceActionResponseItem", "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": "GetProposedWorkOrderMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "proposedWorkOrderDescription": { "title": "proposedWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderMeter->ProposedWorkOrder_Description" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Code" }, "scheduledDate": { "title": "scheduledDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrderMeter->ScheduledDate" }, "scheduledMeterReading": { "title": "scheduledMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ScheduledMeterReading" } } }, "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" } } } }, "GetProposedWorkOrderMeterForProposedWorkOrderCollectionResourceActionResponse": { "title": "GetProposedWorkOrderMeterForProposedWorkOrderCollectionResourceActionResponse", "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": "GetProposedWorkOrderMeterForProposedWorkOrderCollectionResourceActionResponseItem", "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": "GetProposedWorkOrderMeterForProposedWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderMeter->Meter_Code" }, "scheduledDate": { "title": "scheduledDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrderMeter->ScheduledDate" }, "scheduledMeterReading": { "title": "scheduledMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderMeter->ScheduledMeterReading" } } }, "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" } } } }, "BatchGetProposedWorkOrderMeterResourceAction": { "title": "BatchGetProposedWorkOrderMeterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Proposed Work Order Meter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Proposed Work Order Meter entities", "items": { "$ref": "#/definitions/GetProposedWorkOrderMeterResourceActionResponse" } }, "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" } } }, "GetProposedWorkOrderTaskResourceActionResponse": { "title": "GetProposedWorkOrderTaskResourceActionResponse", "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": "GetProposedWorkOrderTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Site_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AlternativeDescription" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Asset_Code" }, "assetTaskId": { "title": "assetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Id" }, "assetTaskCode": { "title": "assetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Code" }, "assetTaskDescription": { "title": "assetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Description" }, "assetTaskInspectionType": { "title": "assetTaskInspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_InspectionType", "x-formatSpecifier": "InspectionType" }, "defaultIntervalId": { "title": "defaultIntervalId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->DefaultInterval_Id" }, "defaultIntervalCode": { "title": "defaultIntervalCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->DefaultInterval_Code" }, "defaultIntervalDescription": { "title": "defaultIntervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->DefaultInterval_Description" }, "defaultIntervalTaskIntervalTypeId": { "title": "defaultIntervalTaskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->DefaultInterval_TaskIntervalType_Id" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Description" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrderTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->DueReading" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Event_Description" }, "failedReason": { "title": "failedReason", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->FailedReason" }, "intervalTypeId": { "title": "intervalTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->IntervalType_Id" }, "intervalTypeCode": { "title": "intervalTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->IntervalType_Code" }, "intervalTypeDescription": { "title": "intervalTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->IntervalType_Description" }, "intervalTypeSchedulingKind": { "title": "intervalTypeSchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->IntervalType_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->IsStatutory" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->IsSuppressed" }, "lastDoneDate": { "title": "lastDoneDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderTask->LastDoneDate" }, "lastDoneReading": { "title": "lastDoneReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->LastDoneReading" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MachineState", "x-formatSpecifier": "MachineState" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_Code" }, "meterLastReading": { "title": "meterLastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_LastReading" }, "meterAverageDailyRate": { "title": "meterAverageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_AverageDailyRate" }, "meterCumulativeReading": { "title": "meterCumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_CumulativeReading" }, "meterLastReadOn": { "title": "meterLastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderTask->Meter_LastReadOn" }, "meterNotes": { "title": "meterNotes", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_Notes" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->Meter_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_Description" }, "monitoringPointIsCalculated": { "title": "monitoringPointIsCalculated", "type": "boolean", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_IsCalculated" }, "monitoringPointMonitoringPointTypeId": { "title": "monitoringPointMonitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Id" }, "monitoringPointMonitoringPointTypeCode": { "title": "monitoringPointMonitoringPointTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Code" }, "monitoringPointMonitoringPointTypeDescription": { "title": "monitoringPointMonitoringPointTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MonitoringPoint_MonitoringPointType_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->MotionType", "x-formatSpecifier": "MotionType" }, "proposedWorkOrderId": { "title": "proposedWorkOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->ProposedWorkOrder_Id" }, "proposedWorkOrderDescription": { "title": "proposedWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ProposedWorkOrder_Description" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceDescription": { "title": "responsibleStaffMemberResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_Description" }, "responsibleStaffMemberResourceResourceType": { "title": "responsibleStaffMemberResourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_ResourceType", "x-formatSpecifier": "ResourceType" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleStaffMemberResourceContactDetailDepartment": { "title": "responsibleStaffMemberResourceContactDetailDepartment", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailDepartment" }, "responsibleStaffMemberResourceContactDetailJobTitle": { "title": "responsibleStaffMemberResourceContactDetailJobTitle", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_ContactDetailJobTitle" }, "responsibleStaffMemberResourceSiteId": { "title": "responsibleStaffMemberResourceSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Id" }, "responsibleStaffMemberResourceSiteCode": { "title": "responsibleStaffMemberResourceSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Code" }, "responsibleStaffMemberResourceSiteDescription": { "title": "responsibleStaffMemberResourceSiteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleStaffMemberResource_Site_Description" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ResponsibleTrade_Description" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "suppressedBy": { "title": "suppressedBy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->SuppressedBy", "x-formatSpecifier": "SuppressedBy" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ProposedWorkOrderTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ProposedWorkOrderTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->TypeOfWork_Description" }, "typeOfWorkWorkType": { "title": "typeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->TypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } }, "GetProposedWorkOrderTaskCollectionResourceActionResponse": { "title": "GetProposedWorkOrderTaskCollectionResourceActionResponse", "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": "GetProposedWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetProposedWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "proposedWorkOrderId": { "title": "proposedWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->ProposedWorkOrder_Id" }, "proposedWorkOrderDescription": { "title": "proposedWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->ProposedWorkOrder_Description" }, "proposedWorkOrderAssetCode": { "title": "proposedWorkOrderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->ProposedWorkOrder_Asset_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->Asset_Code" }, "assetTaskId": { "title": "assetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Id" }, "assetTaskCode": { "title": "assetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Code" }, "assetTaskAssetCode": { "title": "assetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Asset_Code" }, "failedReason": { "title": "failedReason", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->FailedReason" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->Meter_Code" }, "suppressedBy": { "title": "suppressedBy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->SuppressedBy", "x-formatSpecifier": "SuppressedBy" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->Site_Code" }, "intervalTypeCode": { "title": "intervalTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->IntervalType_Code" }, "defaultIntervalCode": { "title": "defaultIntervalCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->DefaultInterval_Code" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrderTask->DueDate" }, "lastDoneDate": { "title": "lastDoneDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderTask->LastDoneDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->DueReading" }, "lastDoneReading": { "title": "lastDoneReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->LastDoneReading" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ProposedWorkOrderTask->CreatedOn" } } }, "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" } } } }, "GetProposedWorkOrderTaskForProposedWorkOrderCollectionResourceActionResponse": { "title": "GetProposedWorkOrderTaskForProposedWorkOrderCollectionResourceActionResponse", "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": "GetProposedWorkOrderTaskForProposedWorkOrderCollectionResourceActionResponseItem", "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": "GetProposedWorkOrderTaskForProposedWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetCode": { "title": "assetCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->Asset_Code" }, "assetTaskId": { "title": "assetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Id" }, "assetTaskCode": { "title": "assetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->AssetTask_Code" }, "failedReason": { "title": "failedReason", "type": "string", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->FailedReason" }, "suppressedBy": { "title": "suppressedBy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->SuppressedBy", "x-formatSpecifier": "SuppressedBy" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "intervalTypeCode": { "title": "intervalTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->IntervalType_Code" }, "defaultIntervalCode": { "title": "defaultIntervalCode", "type": "string", "x-nullable": false, "x-propertyPath": "ProposedWorkOrderTask->DefaultInterval_Code" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "ProposedWorkOrderTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ProposedWorkOrderTask->DueReading" } } }, "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" } } } }, "BatchGetProposedWorkOrderTaskResourceAction": { "title": "BatchGetProposedWorkOrderTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Proposed Work Order Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Proposed Work Order Task entities", "items": { "$ref": "#/definitions/GetProposedWorkOrderTaskResourceActionResponse" } }, "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" } } }, "GetServiceLevelAgreementResourceActionResponse": { "title": "GetServiceLevelAgreementResourceActionResponse", "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": "GetServiceLevelAgreementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreement->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreement->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Description" }, "isInitialised": { "title": "isInitialised", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->IsInitialised" }, "isTemplate": { "title": "isTemplate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->IsTemplate" }, "matchCriteria": { "title": "matchCriteria", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->MatchCriteria" }, "measureFromAssignedDate": { "title": "measureFromAssignedDate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->MeasureFromAssignedDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->Notes" }, "resetMeasurementOnReAssignDate": { "title": "resetMeasurementOnReAssignDate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->ResetMeasurementOnReAssignDate" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->SequenceNumber" }, "serviceLevelAgreementClassificationId": { "title": "serviceLevelAgreementClassificationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->ServiceLevelAgreementClassification_Id" }, "serviceLevelAgreementClassificationCode": { "title": "serviceLevelAgreementClassificationCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->ServiceLevelAgreementClassification_Code" }, "serviceLevelAgreementClassificationDescription": { "title": "serviceLevelAgreementClassificationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->ServiceLevelAgreementClassification_Description" }, "templateServiceLevelAgreementId": { "title": "templateServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->TemplateServiceLevelAgreement_Id" }, "templateServiceLevelAgreementCode": { "title": "templateServiceLevelAgreementCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->TemplateServiceLevelAgreement_Code" }, "templateServiceLevelAgreementDescription": { "title": "templateServiceLevelAgreementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->TemplateServiceLevelAgreement_Description" }, "workOrderEndStatusId": { "title": "workOrderEndStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderEndStatus_Id" }, "workOrderEndStatusCode": { "title": "workOrderEndStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderEndStatus_Code" }, "workOrderEndStatusDescription": { "title": "workOrderEndStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderEndStatus_Description" }, "workOrderEndStatusBaseStatus": { "title": "workOrderEndStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderEndStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderStartStatusId": { "title": "workOrderStartStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderStartStatus_Id" }, "workOrderStartStatusCode": { "title": "workOrderStartStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderStartStatus_Code" }, "workOrderStartStatusDescription": { "title": "workOrderStartStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderStartStatus_Description" }, "workOrderStartStatusBaseStatus": { "title": "workOrderStartStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->WorkOrderStartStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "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" } } }, "GetServiceLevelAgreementCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementCollectionResourceActionResponse", "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": "GetServiceLevelAgreementCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Description" }, "isInitialised": { "title": "isInitialised", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->IsInitialised" }, "serviceLevelAgreementClassificationCode": { "title": "serviceLevelAgreementClassificationCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->ServiceLevelAgreementClassification_Code" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->PermissionTree_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->Notes" } } }, "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" } } } }, "ServiceLevelAgreementChangePermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementChangePermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementChangePermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementInsertPermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementInsertPermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementInsertPermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementServiceLevelAgreementClassificationLookupResourceActionResponse": { "title": "ServiceLevelAgreementServiceLevelAgreementClassificationLookupResourceActionResponse", "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": "ServiceLevelAgreementServiceLevelAgreementClassificationLookupResourceActionResponseItem", "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": "ServiceLevelAgreementServiceLevelAgreementClassificationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->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" } } } }, "CreateServiceLevelAgreementResourceActionRequest": { "title": "CreateServiceLevelAgreementResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateServiceLevelAgreementResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "serviceLevelAgreementClassificationId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Description" }, "serviceLevelAgreementClassificationId": { "title": "serviceLevelAgreementClassificationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->ServiceLevelAgreementClassification_Id" }, "matchCriteria": { "title": "matchCriteria", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->MatchCriteria" }, "measureFromAssignedDate": { "title": "measureFromAssignedDate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->MeasureFromAssignedDate" }, "resetMeasurementOnReAssignDate": { "title": "resetMeasurementOnReAssignDate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->ResetMeasurementOnReAssignDate" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->Notes" } } }, "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" } } }, "UpdateServiceLevelAgreementResourceActionRequest": { "title": "UpdateServiceLevelAgreementResourceActionRequest", "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": "ServiceLevelAgreement->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Description" }, { "title": "matchCriteria", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->MatchCriteria" }, { "title": "measureFromAssignedDate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->MeasureFromAssignedDate" }, { "title": "resetMeasurementOnReAssignDate", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->ResetMeasurementOnReAssignDate" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreement->Notes" } ] } } }, "DeleteServiceLevelAgreementResourceActionRequest": { "title": "DeleteServiceLevelAgreementResourceActionRequest", "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 } } }, "BatchGetServiceLevelAgreementResourceAction": { "title": "BatchGetServiceLevelAgreementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Service Level Agreement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Service Level Agreement entities", "items": { "$ref": "#/definitions/GetServiceLevelAgreementResourceActionResponse" } }, "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" } } }, "BatchCreateServiceLevelAgreementResourceActionRequest": { "title": "BatchCreateServiceLevelAgreementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateServiceLevelAgreementResourceActionRequest" } }, "BatchUpdateServiceLevelAgreementResourceActionRequest": { "title": "BatchUpdateServiceLevelAgreementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateServiceLevelAgreementResourceActionRequest" } }, "BatchDeleteServiceLevelAgreementResourceActionRequest": { "title": "BatchDeleteServiceLevelAgreementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteServiceLevelAgreementResourceActionRequest" } }, "ChangeServiceLevelAgreementIsActiveResourceActionRequest": { "title": "ChangeServiceLevelAgreementIsActiveResourceActionRequest", "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": "ServiceLevelAgreement->IsActive" } ] } } }, "ChangeServiceLevelAgreementIsInitialisedResourceActionRequest": { "title": "ChangeServiceLevelAgreementIsInitialisedResourceActionRequest", "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": "isInitialised", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeServiceLevelAgreementIsInitialised->IsInitialised" } ] } } }, "ChangeServiceLevelAgreementPermissionTreeResourceActionRequest": { "title": "ChangeServiceLevelAgreementPermissionTreeResourceActionRequest", "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": "ServiceLevelAgreement->PermissionTree_Id" } ] } } }, "PullServiceLevelAgreementTemplateUpdatesResourceActionRequest": { "title": "PullServiceLevelAgreementTemplateUpdatesResourceActionRequest", "type": "object", "properties": { "properties": { "title": "PullServiceLevelAgreementTemplateUpdatesResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "serviceLevelAgreementIds": { "title": "serviceLevelAgreementIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "PullServiceLevelAgreementTemplateUpdates->ServiceLevelAgreementIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PushServiceLevelAgreementTemplateUpdatesResourceActionRequest": { "title": "PushServiceLevelAgreementTemplateUpdatesResourceActionRequest", "type": "object", "properties": { "properties": { "title": "PushServiceLevelAgreementTemplateUpdatesResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "serviceLevelAgreementIds": { "title": "serviceLevelAgreementIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "PushServiceLevelAgreementTemplateUpdates->ServiceLevelAgreementIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeServiceLevelAgreementIsActiveResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementIsActiveResourceActionRequest" } }, "BatchChangeServiceLevelAgreementPermissionTreeResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementPermissionTreeResourceActionRequest" } }, "GetServiceLevelAgreementClassificationResourceActionResponse": { "title": "GetServiceLevelAgreementClassificationResourceActionResponse", "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": "GetServiceLevelAgreementClassificationResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementClassification->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementClassification->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Description" }, "matchType": { "title": "matchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->MatchType", "x-formatSpecifier": "SLAClassificationMatchType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->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" } } }, "GetServiceLevelAgreementClassificationCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementClassificationCollectionResourceActionResponse", "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": "GetServiceLevelAgreementClassificationCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementClassificationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Description" }, "matchType": { "title": "matchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->MatchType", "x-formatSpecifier": "SLAClassificationMatchType" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->PermissionTree_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->Notes" } } }, "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" } } } }, "ServiceLevelAgreementClassificationChangePermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementClassificationChangePermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementClassificationChangePermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementClassificationChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementClassificationInsertPermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementClassificationInsertPermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementClassificationInsertPermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementClassificationInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateServiceLevelAgreementClassificationResourceActionRequest": { "title": "CreateServiceLevelAgreementClassificationResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateServiceLevelAgreementClassificationResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "matchType" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Description" }, "matchType": { "title": "matchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->MatchType", "x-formatSpecifier": "SLAClassificationMatchType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateServiceLevelAgreementClassificationResourceActionRequest": { "title": "UpdateServiceLevelAgreementClassificationResourceActionRequest", "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": "ServiceLevelAgreementClassification->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->Description" }, { "title": "matchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementClassification->MatchType", "x-formatSpecifier": "SLAClassificationMatchType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementClassification->Notes" } ] } } }, "DeleteServiceLevelAgreementClassificationResourceActionRequest": { "title": "DeleteServiceLevelAgreementClassificationResourceActionRequest", "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 } } }, "BatchGetServiceLevelAgreementClassificationResourceAction": { "title": "BatchGetServiceLevelAgreementClassificationResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Service Level Agreement Classification entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Service Level Agreement Classification entities", "items": { "$ref": "#/definitions/GetServiceLevelAgreementClassificationResourceActionResponse" } }, "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" } } }, "BatchCreateServiceLevelAgreementClassificationResourceActionRequest": { "title": "BatchCreateServiceLevelAgreementClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateServiceLevelAgreementClassificationResourceActionRequest" } }, "BatchUpdateServiceLevelAgreementClassificationResourceActionRequest": { "title": "BatchUpdateServiceLevelAgreementClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateServiceLevelAgreementClassificationResourceActionRequest" } }, "BatchDeleteServiceLevelAgreementClassificationResourceActionRequest": { "title": "BatchDeleteServiceLevelAgreementClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteServiceLevelAgreementClassificationResourceActionRequest" } }, "ChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest": { "title": "ChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest", "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": "ServiceLevelAgreementClassification->IsActive" } ] } } }, "ChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest": { "title": "ChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest", "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": "ServiceLevelAgreementClassification->PermissionTree_Id" } ] } } }, "BatchChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementClassificationIsActiveResourceActionRequest" } }, "BatchChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementClassificationPermissionTreeResourceActionRequest" } }, "GetServiceLevelAgreementMeasureResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureResourceActionResponse", "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": "GetServiceLevelAgreementMeasureResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementMeasure->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementMeasure->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->PermissionTree_Description" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Calendar_Id", "x-NullExpression": "ServiceLevelAgreementMeasure->CalendarType eq 'Custom'" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Calendar_Description" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->CalendarType", "x-formatSpecifier": "SLACalendarType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Description" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasure->Duration" }, "isMain": { "title": "isMain", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->IsMain" }, "isTemplate": { "title": "isTemplate", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->IsTemplate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Notes" }, "resettableMeasure": { "title": "resettableMeasure", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ResettableMeasure" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->SequenceNumber" }, "serviceLevelAgreementId": { "title": "serviceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id" }, "serviceLevelAgreementCode": { "title": "serviceLevelAgreementCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code" }, "serviceLevelAgreementDescription": { "title": "serviceLevelAgreementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Description" }, "templateServiceLevelAgreementMeasureId": { "title": "templateServiceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Id" }, "templateServiceLevelAgreementMeasureCode": { "title": "templateServiceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Code" }, "templateServiceLevelAgreementMeasureDescription": { "title": "templateServiceLevelAgreementMeasureDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->TemplateServiceLevelAgreementMeasure_Description" }, "workOrderEndStatusId": { "title": "workOrderEndStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id" }, "workOrderEndStatusCode": { "title": "workOrderEndStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code" }, "workOrderEndStatusDescription": { "title": "workOrderEndStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Description" }, "workOrderEndStatusBaseStatus": { "title": "workOrderEndStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderStartStatusId": { "title": "workOrderStartStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id" }, "workOrderStartStatusCode": { "title": "workOrderStartStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code" }, "workOrderStartStatusDescription": { "title": "workOrderStartStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Description" }, "workOrderStartStatusBaseStatus": { "title": "workOrderStartStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "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" } } }, "GetServiceLevelAgreementMeasureCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureCollectionResourceActionResponse", "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": "GetServiceLevelAgreementMeasureCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementMeasureCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, "serviceLevelAgreementCode": { "title": "serviceLevelAgreementCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Description" }, "isMain": { "title": "isMain", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->IsMain" }, "workOrderStartStatusCode": { "title": "workOrderStartStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code" }, "workOrderEndStatusCode": { "title": "workOrderEndStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->SequenceNumber" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->CalendarType", "x-formatSpecifier": "SLACalendarType" }, "resettableMeasure": { "title": "resettableMeasure", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ResettableMeasure" } } }, "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" } } } }, "GetServiceLevelAgreementMeasureForServiceLevelAgreementCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureForServiceLevelAgreementCollectionResourceActionResponse", "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": "GetServiceLevelAgreementMeasureForServiceLevelAgreementCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementMeasureForServiceLevelAgreementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Description" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasure->Duration" }, "serviceLevelAgreementId": { "title": "serviceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id" }, "serviceLevelAgreementCode": { "title": "serviceLevelAgreementCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Code" }, "isMain": { "title": "isMain", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->IsMain" }, "workOrderStartStatusId": { "title": "workOrderStartStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id" }, "workOrderStartStatusCode": { "title": "workOrderStartStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Code" }, "workOrderEndStatusId": { "title": "workOrderEndStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id" }, "workOrderEndStatusCode": { "title": "workOrderEndStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->SequenceNumber" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->CalendarType", "x-formatSpecifier": "SLACalendarType" }, "resettableMeasure": { "title": "resettableMeasure", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ResettableMeasure" } } }, "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" } } } }, "ServiceLevelAgreementMeasureCalendarLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureCalendarLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureCalendarLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureCalendarLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->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" } } } }, "ServiceLevelAgreementMeasureChangePermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureChangePermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureChangePermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementMeasureInsertPermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureInsertPermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureInsertPermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementMeasureServiceLevelAgreementLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureServiceLevelAgreementLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureServiceLevelAgreementLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureServiceLevelAgreementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreement->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" } } } }, "ServiceLevelAgreementMeasureWorkOrderEndStatusLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureWorkOrderEndStatusLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureWorkOrderEndStatusLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureWorkOrderEndStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->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" } } } }, "ServiceLevelAgreementMeasureWorkOrderStartStatusLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureWorkOrderStartStatusLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureWorkOrderStartStatusLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureWorkOrderStartStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->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" } } } }, "CreateServiceLevelAgreementMeasureResourceActionRequest": { "title": "CreateServiceLevelAgreementMeasureResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateServiceLevelAgreementMeasureResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "serviceLevelAgreementId", "isMain", "workOrderStartStatusId", "workOrderEndStatusId", "calendarType", "description" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->PermissionTree_Id", "x-systemGenerated": true }, "serviceLevelAgreementId": { "title": "serviceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->ServiceLevelAgreement_Id" }, "isMain": { "title": "isMain", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->IsMain" }, "workOrderStartStatusId": { "title": "workOrderStartStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id" }, "workOrderEndStatusId": { "title": "workOrderEndStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->CalendarType", "x-formatSpecifier": "SLACalendarType" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Description" }, "duration": { "title": "duration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "exclusiveMinimum": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Duration" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Calendar_Id", "x-NullExpression": "ServiceLevelAgreementMeasure->CalendarType eq 'Custom'" }, "resettableMeasure": { "title": "resettableMeasure", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ResettableMeasure" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateServiceLevelAgreementMeasureResourceActionRequest": { "title": "UpdateServiceLevelAgreementMeasureResourceActionRequest", "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", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, { "title": "isMain", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->IsMain" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Description" }, { "title": "workOrderStartStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderStartStatus_Id" }, { "title": "workOrderEndStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->WorkOrderEndStatus_Id" }, { "title": "duration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "exclusiveMinimum": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Duration" }, { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->CalendarType", "x-formatSpecifier": "SLACalendarType" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->Calendar_Id", "x-NullExpression": "ServiceLevelAgreementMeasure->CalendarType eq 'Custom'" }, { "title": "resettableMeasure", "type": "boolean", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->ResettableMeasure" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Notes" } ] } } }, "DeleteServiceLevelAgreementMeasureResourceActionRequest": { "title": "DeleteServiceLevelAgreementMeasureResourceActionRequest", "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 } } }, "BatchGetServiceLevelAgreementMeasureResourceAction": { "title": "BatchGetServiceLevelAgreementMeasureResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Service Level Agreement Measure entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Service Level Agreement Measure entities", "items": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureResourceActionResponse" } }, "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" } } }, "BatchCreateServiceLevelAgreementMeasureResourceActionRequest": { "title": "BatchCreateServiceLevelAgreementMeasureResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateServiceLevelAgreementMeasureResourceActionRequest" } }, "BatchUpdateServiceLevelAgreementMeasureResourceActionRequest": { "title": "BatchUpdateServiceLevelAgreementMeasureResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateServiceLevelAgreementMeasureResourceActionRequest" } }, "BatchDeleteServiceLevelAgreementMeasureResourceActionRequest": { "title": "BatchDeleteServiceLevelAgreementMeasureResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteServiceLevelAgreementMeasureResourceActionRequest" } }, "ChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest": { "title": "ChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest", "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": "ServiceLevelAgreementMeasure->IsActive" } ] } } }, "ChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest": { "title": "ChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest", "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": "ServiceLevelAgreementMeasure->PermissionTree_Id" } ] } } }, "PullServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequest": { "title": "PullServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequest", "type": "object", "properties": { "properties": { "title": "PullServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "serviceLevelAgreementMeasureIds": { "title": "serviceLevelAgreementMeasureIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "PullServiceLevelAgreementMeasureTemplateUpdates->ServiceLevelAgreementMeasureIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PushServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequest": { "title": "PushServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequest", "type": "object", "properties": { "properties": { "title": "PushServiceLevelAgreementMeasureTemplateUpdatesResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "serviceLevelAgreementMeasureIds": { "title": "serviceLevelAgreementMeasureIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "PushServiceLevelAgreementMeasureTemplateUpdates->ServiceLevelAgreementMeasureIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureIsActiveResourceActionRequest" } }, "BatchChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasurePermissionTreeResourceActionRequest" } }, "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" } } }, "GetServiceLevelAgreementMeasureFieldAssignmentResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureFieldAssignmentResourceActionResponse", "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": "GetServiceLevelAgreementMeasureFieldAssignmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ModifiedOn" }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Description" }, "targetFieldType": { "title": "targetFieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType", "x-formatSpecifier": "SLAMeasureFieldAssignmentTargetFieldType" }, "actionWhen": { "title": "actionWhen", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ActionWhen", "x-formatSpecifier": "SLAMeasureFieldAssignmentActionWhen" }, "valueSource": { "title": "valueSource", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ValueSource", "x-formatSpecifier": "SLAMeasureFieldAssignmentValueSource" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Notes" }, "targetField": { "title": "targetField", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetField" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->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" } } }, "GetServiceLevelAgreementMeasureFieldAssignmentCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureFieldAssignmentCollectionResourceActionResponse", "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": "GetServiceLevelAgreementMeasureFieldAssignmentCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementMeasureFieldAssignmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Description" }, "targetField": { "title": "targetField", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetField" }, "actionWhen": { "title": "actionWhen", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ActionWhen", "x-formatSpecifier": "SLAMeasureFieldAssignmentActionWhen" }, "targetFieldType": { "title": "targetFieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType", "x-formatSpecifier": "SLAMeasureFieldAssignmentTargetFieldType" }, "valueSource": { "title": "valueSource", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ValueSource", "x-formatSpecifier": "SLAMeasureFieldAssignmentValueSource" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->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" } } } }, "GetServiceLevelAgreementMeasureFieldAssignmentForServiceLevelAgreementMeasureCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureFieldAssignmentForServiceLevelAgreementMeasureCollectionResourceActionResponse", "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": "GetServiceLevelAgreementMeasureFieldAssignmentForServiceLevelAgreementMeasureCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementMeasureFieldAssignmentForServiceLevelAgreementMeasureCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Description" }, "targetField": { "title": "targetField", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetField" }, "actionWhen": { "title": "actionWhen", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ActionWhen", "x-formatSpecifier": "SLAMeasureFieldAssignmentActionWhen" }, "targetFieldType": { "title": "targetFieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType", "x-formatSpecifier": "SLAMeasureFieldAssignmentTargetFieldType" }, "valueSource": { "title": "valueSource", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ValueSource", "x-formatSpecifier": "SLAMeasureFieldAssignmentValueSource" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->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" } } } }, "ServiceLevelAgreementMeasureFieldAssignmentChangePermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureFieldAssignmentChangePermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureFieldAssignmentChangePermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureFieldAssignmentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementMeasureFieldAssignmentEntityPropertyLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureFieldAssignmentEntityPropertyLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureFieldAssignmentEntityPropertyLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureFieldAssignmentEntityPropertyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "path": { "title": "path", "type": "string", "x-nullable": true, "x-propertyPath": "EntityMetadataPropertySummary->Path" } } }, "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" } } } }, "ServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureFieldAssignmentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureFieldAssignmentServiceLevelAgreementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->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" } } } }, "CreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest": { "title": "CreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "serviceLevelAgreementMeasureId", "description", "targetFieldType", "targetField", "actionWhen", "valueSource" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id", "x-systemGenerated": true }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ServiceLevelAgreementMeasure_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Description" }, "targetFieldType": { "title": "targetFieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType", "x-formatSpecifier": "SLAMeasureFieldAssignmentTargetFieldType" }, "targetField": { "title": "targetField", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetField" }, "actionWhen": { "title": "actionWhen", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ActionWhen", "x-formatSpecifier": "SLAMeasureFieldAssignmentActionWhen" }, "valueSource": { "title": "valueSource", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ValueSource", "x-formatSpecifier": "SLAMeasureFieldAssignmentValueSource" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest": { "title": "UpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest", "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": "ServiceLevelAgreementMeasureFieldAssignment->Code" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Description" }, { "title": "targetFieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetFieldType", "x-formatSpecifier": "SLAMeasureFieldAssignmentTargetFieldType" }, { "title": "targetField", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->TargetField" }, { "title": "actionWhen", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ActionWhen", "x-formatSpecifier": "SLAMeasureFieldAssignmentActionWhen" }, { "title": "valueSource", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->ValueSource", "x-formatSpecifier": "SLAMeasureFieldAssignmentValueSource" }, { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureFieldAssignment->Notes" } ] } } }, "DeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest": { "title": "DeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest", "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 } } }, "BatchGetServiceLevelAgreementMeasureFieldAssignmentResourceAction": { "title": "BatchGetServiceLevelAgreementMeasureFieldAssignmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Service Level Agreement Measure Field Assignment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Service Level Agreement Measure Field Assignment entities", "items": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureFieldAssignmentResourceActionResponse" } }, "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" } } }, "BatchCreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest": { "title": "BatchCreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, "BatchUpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest": { "title": "BatchUpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, "BatchDeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest": { "title": "BatchDeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteServiceLevelAgreementMeasureFieldAssignmentResourceActionRequest" } }, "ChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest": { "title": "ChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest", "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": "ServiceLevelAgreementMeasureFieldAssignment->IsActive" } ] } } }, "ChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest": { "title": "ChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest", "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": "ServiceLevelAgreementMeasureFieldAssignment->PermissionTree_Id" } ] } } }, "BatchChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureFieldAssignmentIsActiveResourceActionRequest" } }, "BatchChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureFieldAssignmentPermissionTreeResourceActionRequest" } }, "GetServiceLevelAgreementMeasureTriggerResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureTriggerResourceActionResponse", "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": "GetServiceLevelAgreementMeasureTriggerResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->PermissionTree_Description" }, "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Notes" }, "percentage": { "title": "percentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Percentage" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotification" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->SequenceNumber" }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_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" } } }, "GetServiceLevelAgreementMeasureTriggerCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureTriggerCollectionResourceActionResponse", "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": "GetServiceLevelAgreementMeasureTriggerCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementMeasureTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Description" }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Description" }, "percentage": { "title": "percentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Percentage" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotification" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_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" } } } }, "GetServiceLevelAgreementMeasureTriggerForServiceLevelAgreementMeasureCollectionResourceActionResponse": { "title": "GetServiceLevelAgreementMeasureTriggerForServiceLevelAgreementMeasureCollectionResourceActionResponse", "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": "GetServiceLevelAgreementMeasureTriggerForServiceLevelAgreementMeasureCollectionResourceActionResponseItem", "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": "GetServiceLevelAgreementMeasureTriggerForServiceLevelAgreementMeasureCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Description" }, "percentage": { "title": "percentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Percentage" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotification" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ChangeDataTrigger_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" } } } }, "ServiceLevelAgreementMeasureTriggerChangePermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureTriggerChangePermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureTriggerChangePermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureTriggerChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementMeasureTriggerInsertPermissionTreeLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureTriggerInsertPermissionTreeLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureTriggerInsertPermissionTreeLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureTriggerInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ServiceLevelAgreementMeasureTriggerServiceLevelAgreementLookupResourceActionResponse": { "title": "ServiceLevelAgreementMeasureTriggerServiceLevelAgreementLookupResourceActionResponse", "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": "ServiceLevelAgreementMeasureTriggerServiceLevelAgreementLookupResourceActionResponseItem", "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": "ServiceLevelAgreementMeasureTriggerServiceLevelAgreementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasure->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasure->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" } } } }, "CreateServiceLevelAgreementMeasureTriggerResourceActionRequest": { "title": "CreateServiceLevelAgreementMeasureTriggerResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateServiceLevelAgreementMeasureTriggerResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "serviceLevelAgreementMeasureId", "description", "percentage" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->PermissionTree_Id", "x-systemGenerated": true }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->ServiceLevelAgreementMeasure_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Description" }, "percentage": { "title": "percentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Percentage" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotification" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit", "x-MinValueExpression": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit ne null" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateServiceLevelAgreementMeasureTriggerResourceActionRequest": { "title": "UpdateServiceLevelAgreementMeasureTriggerResourceActionRequest", "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": "ServiceLevelAgreementMeasureTrigger->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Description" }, { "title": "percentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Percentage" }, { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotification" }, { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit", "x-MinValueExpression": "ServiceLevelAgreementMeasureTrigger->RepeatNotificationLimit ne null" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ServiceLevelAgreementMeasureTrigger->Notes" } ] } } }, "DeleteServiceLevelAgreementMeasureTriggerResourceActionRequest": { "title": "DeleteServiceLevelAgreementMeasureTriggerResourceActionRequest", "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 } } }, "BatchGetServiceLevelAgreementMeasureTriggerResourceAction": { "title": "BatchGetServiceLevelAgreementMeasureTriggerResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Service Level Agreement Measure Trigger entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Service Level Agreement Measure Trigger entities", "items": { "$ref": "#/definitions/GetServiceLevelAgreementMeasureTriggerResourceActionResponse" } }, "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" } } }, "BatchCreateServiceLevelAgreementMeasureTriggerResourceActionRequest": { "title": "BatchCreateServiceLevelAgreementMeasureTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, "BatchUpdateServiceLevelAgreementMeasureTriggerResourceActionRequest": { "title": "BatchUpdateServiceLevelAgreementMeasureTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, "BatchDeleteServiceLevelAgreementMeasureTriggerResourceActionRequest": { "title": "BatchDeleteServiceLevelAgreementMeasureTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteServiceLevelAgreementMeasureTriggerResourceActionRequest" } }, "ChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest": { "title": "ChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest", "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": "ServiceLevelAgreementMeasureTrigger->IsActive" } ] } } }, "ChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest": { "title": "ChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest", "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": "ServiceLevelAgreementMeasureTrigger->PermissionTree_Id" } ] } } }, "BatchChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureTriggerIsActiveResourceActionRequest" } }, "BatchChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest": { "title": "BatchChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeServiceLevelAgreementMeasureTriggerPermissionTreeResourceActionRequest" } }, "GeoJsonObject": { "type": "object", "discriminator": "type", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeoJsonObjectType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ] }, "bbox": { "title": "bbox", "type": "array", "items": { "type": "number" } } } }, "Feature": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.2", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "required": [ "geometry", "properties" ], "properties": { "geometry": { "allOf": [ { "x-nullable": true }, { "$ref": "#/definitions/Geometry" } ] }, "properties": { "type": "object", "x-nullable": true }, "id": { "oneOf": [ { "type": "number" }, { "type": "string" } ] } } } ] }, "FeatureCollection": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.3", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "required": [ "features" ], "properties": { "features": { "type": "array", "items": { "$ref": "#/definitions/Feature" } } } } ] }, "LinearRing": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.6", "minItems": 4, "items": { "$ref": "#/definitions/Position" } }, "LineStringCoordinates": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.4", "minItems": 2, "items": { "$ref": "#/definitions/Position" } }, "Position": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.1", "maxItems": 3, "minItems": 2, "items": { "type": "number" } }, "GeometryElement": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1", "allOf": [ { "$ref": "#/definitions/Geometry" }, { "type": "object", "discriminator": "type", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeometryElementType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon" ] } } } ] }, "GeometryCollection": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.8", "allOf": [ { "$ref": "#/definitions/Geometry" }, { "type": "object", "required": [ "geometries" ], "properties": { "geometries": { "type": "array", "items": { "$ref": "#/definitions/GeometryElement" } } } } ] }, "Geometry": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "discriminator": "type", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeometryType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection" ] } } } ] }, "Point": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.2", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/definitions/Position" } } } ] }, "MultiPoint": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.3", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/Position" } } } } ] }, "LineString": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.4", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/definitions/LineStringCoordinates" } } } ] }, "MultiLineString": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.5", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/LineStringCoordinates" } } } } ] }, "Polygon": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.6", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/LinearRing" } } } } ] }, "MultiPolygon": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.7", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/LinearRing" } } } } } ] }, "TreePathItem": { "type": "object", "required": [ "sequence" ], "properties": { "sequence": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "description": { "type": "string" }, "alternativeDescription": { "type": "string" } } }, "GetWorkOrderResourceActionResponse": { "title": "GetWorkOrderResourceActionResponse", "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": "GetWorkOrderResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkOrder->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicUnitOfMeasurement_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->CreatedByUser_Id", "x-NullExpression": "WorkOrder->RequesterType eq 'User'" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "codeCounter": { "title": "codeCounter", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->CodeCounter" }, "codePrefix": { "title": "codePrefix", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->CodePrefix" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Site_Description" }, "requester": { "title": "requester", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Requester", "x-NullExpression": "WorkOrder->RequesterType eq 'FreeText'" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterContact_Id", "x-NullExpression": "WorkOrder->RequesterType eq 'User'" }, "requesterContactCode": { "title": "requesterContactCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterContact_Code" }, "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Alarm_Id" }, "alarmDescription": { "title": "alarmDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Alarm_Description" }, "analysisComponentId": { "title": "analysisComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->AnalysisComponent_Id" }, "analysisComponentCode": { "title": "analysisComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AnalysisComponent_Code" }, "analysisComponentDescription": { "title": "analysisComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AnalysisComponent_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Description" }, "assetIsMsi": { "title": "assetIsMsi", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_IsMsi" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetDevelopmentStatus": { "title": "assetDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "assetIsForScheduledWorkOnly": { "title": "assetIsForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_IsForScheduledWorkOnly" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_Id" }, "assetNearestRegularAssetSerialNumber": { "title": "assetNearestRegularAssetSerialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_SerialNumber" }, "assetNearestRegularAssetCode": { "title": "assetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_Code" }, "assetNearestRegularAssetDescription": { "title": "assetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_Description" }, "assetNearestRegularAssetParentAssetId": { "title": "assetNearestRegularAssetParentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_ParentAsset_Id" }, "assetNearestRegularAssetParentAssetCode": { "title": "assetNearestRegularAssetParentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_ParentAsset_Code" }, "assetNearestRegularAssetParentAssetDescription": { "title": "assetNearestRegularAssetParentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_NearestRegularAsset_ParentAsset_Description" }, "assetParentAssetId": { "title": "assetParentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_ParentAsset_Id" }, "assetParentAssetDescription": { "title": "assetParentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_ParentAsset_Description" }, "assetTreePathId": { "title": "assetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_TreePathId" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrder->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetWarranty": { "title": "assetWarranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Warranty", "x-formatSpecifier": "Warranty" }, "assetModificationApproved": { "title": "assetModificationApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationApproved" }, "assetModificationApprovedById": { "title": "assetModificationApprovedById", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationApprovedBy_Id", "x-NullExpression": "WorkOrder->AssetModificationApproved eq TRUE" }, "assetModificationApprovedByCode": { "title": "assetModificationApprovedByCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationApprovedBy_Code" }, "assetModificationApprovedByFullName": { "title": "assetModificationApprovedByFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationApprovedBy_FullName" }, "assetModificationApprovedOn": { "title": "assetModificationApprovedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->AssetModificationApprovedOn", "x-NullExpression": "WorkOrder->AssetModificationApproved eq TRUE" }, "assetModificationInvestigated": { "title": "assetModificationInvestigated", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationInvestigated" }, "assetModificationInvestigatedById": { "title": "assetModificationInvestigatedById", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationInvestigatedBy_Id", "x-NullExpression": "WorkOrder->AssetModificationInvestigated eq TRUE" }, "assetModificationInvestigatedByCode": { "title": "assetModificationInvestigatedByCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationInvestigatedBy_Code" }, "assetModificationInvestigatedByFullName": { "title": "assetModificationInvestigatedByFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationInvestigatedBy_FullName" }, "assetModificationInvestigatedOn": { "title": "assetModificationInvestigatedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->AssetModificationInvestigatedOn", "x-NullExpression": "WorkOrder->AssetModificationInvestigated eq TRUE" }, "assetModificationProposalNumber": { "title": "assetModificationProposalNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationProposalNumber" }, "assetMoved": { "title": "assetMoved", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetMoved" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetType_Description" }, "autoCalculateEstimatedDowntime": { "title": "autoCalculateEstimatedDowntime", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->AutoCalculateEstimatedDowntime" }, "autoCalculateEstimatedDuration": { "title": "autoCalculateEstimatedDuration", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->AutoCalculateEstimatedDuration" }, "completeBy": { "title": "completeBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompleteBy" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompletedOn" }, "contactDescription": { "title": "contactDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ContactDescription" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->CostCentre_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->Duration" }, "email": { "title": "email", "type": "string", "format": "email", "x-nullable": true, "x-propertyPath": "WorkOrder->Email" }, "estimatedDowntime": { "title": "estimatedDowntime", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDowntime" }, "estimatedDuration": { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDuration" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Event_Description" }, "failedComponentId": { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailedComponent_Id", "x-NullExpression": "WorkOrder->Asset_Id eq NULL" }, "failedComponentCode": { "title": "failedComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailedComponent_Code" }, "failedComponentDescription": { "title": "failedComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailedComponent_Description" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCause_Code" }, "failureCauseDescription": { "title": "failureCauseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCause_Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureCauseType_Id", "x-NullExpression": "WorkOrder->FailureCause_Id ne NULL" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCauseType_Description" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanism_Code" }, "failureMechanismDescription": { "title": "failureMechanismDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanism_Description" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureMechanismType_Id", "x-NullExpression": "WorkOrder->FailureMechanism_Id ne NULL" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanismType_Description" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMode_Code" }, "failureModeDescription": { "title": "failureModeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMode_Description" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureModeType_Id", "x-NullExpression": "WorkOrder->FailureMode_Id ne NULL" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureModeType_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeneralLedger_Description" }, "hasServiceLevelAgreement": { "title": "hasServiceLevelAgreement", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->HasServiceLevelAgreement" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Interval_Description" }, "isFailure": { "title": "isFailure", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->IsFailure" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->IsPermitRequired" }, "latestWorkOrderProgressLogId": { "title": "latestWorkOrderProgressLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->LatestWorkOrderProgressLog_Id" }, "latestWorkOrderProgressLogProgressEventId": { "title": "latestWorkOrderProgressLogProgressEventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Id" }, "latestWorkOrderProgressLogProgressEventCode": { "title": "latestWorkOrderProgressLogProgressEventCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Code" }, "latestWorkOrderProgressLogProgressEventDescription": { "title": "latestWorkOrderProgressLogProgressEventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->LatestWorkOrderProgressLog_ProgressEvent_Description" }, "latestWorkOrderProgressLogExecutedOn": { "title": "latestWorkOrderProgressLogExecutedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->LatestWorkOrderProgressLog_ExecutedOn" }, "latestWorkOrderStatusChangeId": { "title": "latestWorkOrderStatusChangeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->LatestWorkOrderStatusChange_Id" }, "latestWorkOrderStatusChangeRemark": { "title": "latestWorkOrderStatusChangeRemark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->LatestWorkOrderStatusChange_Remark" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Location_Description" }, "mainScheduledReading": { "title": "mainScheduledReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->MainScheduledReading" }, "mainServiceLevelAgreementId": { "title": "mainServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->MainServiceLevelAgreement_Id" }, "mainServiceLevelAgreementServiceLevelAgreementId": { "title": "mainServiceLevelAgreementServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Id" }, "mainServiceLevelAgreementServiceLevelAgreementCode": { "title": "mainServiceLevelAgreementServiceLevelAgreementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Code" }, "mainServiceLevelAgreementServiceLevelAgreementDescription": { "title": "mainServiceLevelAgreementServiceLevelAgreementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->MainServiceLevelAgreement_ServiceLevelAgreement_Description" }, "mainServiceLevelAgreementMainMeasurePercentage": { "title": "mainServiceLevelAgreementMainMeasurePercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->MainServiceLevelAgreement_MainMeasurePercentage" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Notes" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Origin", "x-formatSpecifier": "WorkOrderOrigin" }, "parentWorkOrderId": { "title": "parentWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->ParentWorkOrder_Id" }, "parentWorkOrderCode": { "title": "parentWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ParentWorkOrder_Code" }, "parentWorkOrderDescription": { "title": "parentWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ParentWorkOrder_Description" }, "permitNumber": { "title": "permitNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->PermitNumber" }, "phone1": { "title": "phone1", "type": "string", "format": "phone", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1" }, "phone1TypeId": { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1Type_Id" }, "phone1TypeCode": { "title": "phone1TypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1Type_Code" }, "phone1TypeDescription": { "title": "phone1TypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1Type_Description" }, "phone2": { "title": "phone2", "type": "string", "format": "phone", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2" }, "phone2TypeId": { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2Type_Id" }, "phone2TypeCode": { "title": "phone2TypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2Type_Code" }, "phone2TypeDescription": { "title": "phone2TypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2Type_Description" }, "priority": { "title": "priority", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->Priority" }, "progressPercentage": { "title": "progressPercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->ProgressPercentage" }, "receivedOn": { "title": "receivedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ReceivedOn" }, "repairTypeId": { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RepairType_Id" }, "repairTypeCode": { "title": "repairTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->RepairType_Code" }, "repairTypeDescription": { "title": "repairTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->RepairType_Description" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->RequiredBy" }, "scheduledMeters": { "title": "scheduledMeters", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ScheduledMeters" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Section_Description" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Id" }, "staffMemberCode": { "title": "staffMemberCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Code" }, "staffMemberResourceType": { "title": "staffMemberResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ResourceType", "x-formatSpecifier": "ResourceType" }, "staffMemberContactDetailId": { "title": "staffMemberContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ContactDetailId" }, "staffMemberContactDetailFirstName": { "title": "staffMemberContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ContactDetailFirstName" }, "staffMemberContactDetailFullName": { "title": "staffMemberContactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ContactDetailFullName" }, "staffMemberContactDetailLastName": { "title": "staffMemberContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ContactDetailLastName" }, "startOn": { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->StartOn" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_Id" }, "statusCode": { "title": "statusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_Code" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_Description" }, "statusSequenceNumber": { "title": "statusSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_SequenceNumber" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification8_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Trade_Description" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkType": { "title": "typeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "useGlobalLookupLists": { "title": "useGlobalLookupLists", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->UseGlobalLookupLists" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification1_Id" }, "workClassification1Code": { "title": "workClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification1_Code" }, "workClassification1Description": { "title": "workClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification1_Description" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification2_Id" }, "workClassification2Code": { "title": "workClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification2_Code" }, "workClassification2Description": { "title": "workClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification2_Description" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification3_Id" }, "workClassification3Code": { "title": "workClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification3_Code" }, "workClassification3Description": { "title": "workClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification3_Description" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification4_Id" }, "workClassification4Code": { "title": "workClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification4_Code" }, "workClassification4Description": { "title": "workClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification4_Description" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification5_Id" }, "workClassification5Code": { "title": "workClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification5_Code" }, "workClassification5Description": { "title": "workClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification5_Description" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkOrderImportance_Id" }, "workOrderImportanceCode": { "title": "workOrderImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkOrderImportance_Code" }, "workOrderImportanceDescription": { "title": "workOrderImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkOrderImportance_Description" }, "workPerformed": { "title": "workPerformed", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkPerformed" }, "workRequired": { "title": "workRequired", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->WorkRequired" }, "workStartedOn": { "title": "workStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->WorkStartedOn" } } }, "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" } } }, "GetWorkOrderNearestRegularAssetAttributeCollectionResourceActionResponse": { "title": "GetWorkOrderNearestRegularAssetAttributeCollectionResourceActionResponse", "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": "GetWorkOrderNearestRegularAssetAttributeCollectionResourceActionResponseItem", "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": "GetWorkOrderNearestRegularAssetAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->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" } } } }, "GetWorkOrderNearestRegularAssetOptionValueCollectionResourceActionResponse": { "title": "GetWorkOrderNearestRegularAssetOptionValueCollectionResourceActionResponse", "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": "GetWorkOrderNearestRegularAssetOptionValueCollectionResourceActionResponseItem", "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": "GetWorkOrderNearestRegularAssetOptionValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->IsActive" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Description" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_AllowMultipleValues" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Description" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->OptionValue" }, "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->IsCustom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->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" } } } }, "GetFollowUpWorkOrderForWorkOrderCollectionResourceActionResponse": { "title": "GetFollowUpWorkOrderForWorkOrderCollectionResourceActionResponse", "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": "GetFollowUpWorkOrderForWorkOrderCollectionResourceActionResponseItem", "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": "GetFollowUpWorkOrderForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CreatedOn" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Origin", "x-formatSpecifier": "WorkOrderOrigin" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_Id" }, "statusCode": { "title": "statusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_Code" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_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" } } } }, "GetRequisitionForWorkOrderCollectionResourceActionResponse": { "title": "GetRequisitionForWorkOrderCollectionResourceActionResponse", "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": "GetRequisitionForWorkOrderCollectionResourceActionResponseItem", "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": "GetRequisitionForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Requisition->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->PermissionTree_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Description" }, "workOrderCostCentreId": { "title": "workOrderCostCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Id" }, "workOrderCostCentreCode": { "title": "workOrderCostCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Code" }, "workOrderCostCentreDescription": { "title": "workOrderCostCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_CostCentre_Description" }, "workOrderGeneralLedgerId": { "title": "workOrderGeneralLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Id" }, "workOrderGeneralLedgerCode": { "title": "workOrderGeneralLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Code" }, "workOrderGeneralLedgerDescription": { "title": "workOrderGeneralLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_GeneralLedger_Description" }, "workOrderSiteId": { "title": "workOrderSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->WorkOrder_Site_Id" }, "workOrderSiteCode": { "title": "workOrderSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Site_Code" }, "workOrderSiteDescription": { "title": "workOrderSiteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Site_Description" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, "requester": { "title": "requester", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->Requester", "x-NullExpression": "Requisition->RequesterType eq 'FreeText'" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Requisition->RequesterType", "x-formatSpecifier": "RequisitionRequesterType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Requisition->SequenceNumber" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->Status_Id" }, "statusCode": { "title": "statusCode", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->Status_Code" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->Status_Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Requisition->Status_BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" }, "totalItemCost": { "title": "totalItemCost", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Requisition->TotalItemCost" } } }, "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" } } } }, "GetWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Description" }, "receivedOn": { "title": "receivedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ReceivedOn" }, "requester": { "title": "requester", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Requester", "x-NullExpression": "WorkOrder->RequesterType eq 'FreeText'" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->RequiredBy" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Description" }, "completeBy": { "title": "completeBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompleteBy" }, "workStartedOn": { "title": "workStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->WorkStartedOn" }, "startOn": { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->StartOn" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Id" }, "staffMemberCode": { "title": "staffMemberCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->StaffMember_Code" }, "staffMemberContactDetailFullName": { "title": "staffMemberContactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ContactDetailFullName" }, "staffMemberDefaultResourceTradeTradeId": { "title": "staffMemberDefaultResourceTradeTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_DefaultResourceTrade_Trade_Id" }, "staffMemberDefaultResourceTradeTradeCode": { "title": "staffMemberDefaultResourceTradeTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->StaffMember_DefaultResourceTrade_Trade_Code" }, "staffMemberDefaultResourceTradeTradeDescription": { "title": "staffMemberDefaultResourceTradeTradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->StaffMember_DefaultResourceTrade_Trade_Description" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_Id" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_Id" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Alarm_Id" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompletedOn" }, "scheduledMeters": { "title": "scheduledMeters", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ScheduledMeters" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->IsPermitRequired" } } }, "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" } } } }, "GetMovementForWorkOrderCollectionResourceActionResponse": { "title": "GetMovementForWorkOrderCollectionResourceActionResponse", "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": "GetMovementForWorkOrderCollectionResourceActionResponseItem", "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": "GetMovementForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMovement->CreatedOn" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMovement->CreatedByUser_FullName" } } }, "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" } } } }, "GetWorkOrderTaskMovementForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderTaskMovementForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderTaskMovementForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskMovementForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskDescription" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMovement->CreatedOn" }, "workOrderMovementCreatedOn": { "title": "workOrderMovementCreatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_CreatedOn" }, "workOrderMovementCreatedByUserFullName": { "title": "workOrderMovementCreatedByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_CreatedByUser_FullName" }, "workOrderMovementWorkOrderCode": { "title": "workOrderMovementWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Code" } } }, "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" } } } }, "WorkOrderAlarmLookupResourceActionResponse": { "title": "WorkOrderAlarmLookupResourceActionResponse", "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": "WorkOrderAlarmLookupResourceActionResponseItem", "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": "WorkOrderAlarmLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Alarm->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" } } } }, "WorkOrderAnalysisComponentLookupResourceActionResponse": { "title": "WorkOrderAnalysisComponentLookupResourceActionResponse", "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": "WorkOrderAnalysisComponentLookupResourceActionResponseItem", "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": "WorkOrderAnalysisComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "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" } } } }, "WorkOrderAssetLookupResourceActionResponse": { "title": "WorkOrderAssetLookupResourceActionResponse", "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": "WorkOrderAssetLookupResourceActionResponseItem", "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": "WorkOrderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "Asset->IsPermitRequired" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Location_Description" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": true, "x-propertyPath": "Asset->IsMsi" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Barcode" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } } }, "WorkOrderChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderCostCentreLookupResourceActionResponse": { "title": "WorkOrderCostCentreLookupResourceActionResponse", "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": "WorkOrderCostCentreLookupResourceActionResponseItem", "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": "WorkOrderCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->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" } } } }, "WorkOrderEventLookupResourceActionResponse": { "title": "WorkOrderEventLookupResourceActionResponse", "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": "WorkOrderEventLookupResourceActionResponseItem", "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": "WorkOrderEventLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Event->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" } } } }, "WorkOrderFailedComponentLookupResourceActionResponse": { "title": "WorkOrderFailedComponentLookupResourceActionResponse", "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": "WorkOrderFailedComponentLookupResourceActionResponseItem", "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": "WorkOrderFailedComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "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" } } } }, "WorkOrderFailureCauseForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderFailureCauseForAssetComponentLookupResourceActionResponse", "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": "WorkOrderFailureCauseForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderFailureCauseForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_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" } } } }, "WorkOrderFailureCauseForFailureCauseTypeLookupResourceActionResponse": { "title": "WorkOrderFailureCauseForFailureCauseTypeLookupResourceActionResponse", "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": "WorkOrderFailureCauseForFailureCauseTypeLookupResourceActionResponseItem", "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": "WorkOrderFailureCauseForFailureCauseTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_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" } } } }, "WorkOrderFailureCauseLookupResourceActionResponse": { "title": "WorkOrderFailureCauseLookupResourceActionResponse", "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": "WorkOrderFailureCauseLookupResourceActionResponseItem", "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": "WorkOrderFailureCauseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_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" } } } }, "WorkOrderFailureCauseTypeForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderFailureCauseTypeForAssetComponentLookupResourceActionResponse", "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": "WorkOrderFailureCauseTypeForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderFailureCauseTypeForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->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" } } } }, "WorkOrderFailureCauseTypeLookupResourceActionResponse": { "title": "WorkOrderFailureCauseTypeLookupResourceActionResponse", "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": "WorkOrderFailureCauseTypeLookupResourceActionResponseItem", "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": "WorkOrderFailureCauseTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->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" } } } }, "WorkOrderFailureMechanismForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderFailureMechanismForAssetComponentLookupResourceActionResponse", "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": "WorkOrderFailureMechanismForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderFailureMechanismForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_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" } } } }, "WorkOrderFailureMechanismForFailureMechanismTypeLookupResourceActionResponse": { "title": "WorkOrderFailureMechanismForFailureMechanismTypeLookupResourceActionResponse", "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": "WorkOrderFailureMechanismForFailureMechanismTypeLookupResourceActionResponseItem", "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": "WorkOrderFailureMechanismForFailureMechanismTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_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" } } } }, "WorkOrderFailureMechanismLookupResourceActionResponse": { "title": "WorkOrderFailureMechanismLookupResourceActionResponse", "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": "WorkOrderFailureMechanismLookupResourceActionResponseItem", "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": "WorkOrderFailureMechanismLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_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" } } } }, "WorkOrderFailureMechanismTypeForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderFailureMechanismTypeForAssetComponentLookupResourceActionResponse", "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": "WorkOrderFailureMechanismTypeForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderFailureMechanismTypeForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->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" } } } }, "WorkOrderFailureMechanismTypeLookupResourceActionResponse": { "title": "WorkOrderFailureMechanismTypeLookupResourceActionResponse", "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": "WorkOrderFailureMechanismTypeLookupResourceActionResponseItem", "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": "WorkOrderFailureMechanismTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->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" } } } }, "WorkOrderFailureModeForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderFailureModeForAssetComponentLookupResourceActionResponse", "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": "WorkOrderFailureModeForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderFailureModeForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_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" } } } }, "WorkOrderFailureModeForFailureModeTypeLookupResourceActionResponse": { "title": "WorkOrderFailureModeForFailureModeTypeLookupResourceActionResponse", "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": "WorkOrderFailureModeForFailureModeTypeLookupResourceActionResponseItem", "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": "WorkOrderFailureModeForFailureModeTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_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" } } } }, "WorkOrderFailureModeLookupResourceActionResponse": { "title": "WorkOrderFailureModeLookupResourceActionResponse", "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": "WorkOrderFailureModeLookupResourceActionResponseItem", "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": "WorkOrderFailureModeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_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" } } } }, "WorkOrderFailureModeTypeForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderFailureModeTypeForAssetComponentLookupResourceActionResponse", "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": "WorkOrderFailureModeTypeForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderFailureModeTypeForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->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" } } } }, "WorkOrderFailureModeTypeLookupResourceActionResponse": { "title": "WorkOrderFailureModeTypeLookupResourceActionResponse", "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": "WorkOrderFailureModeTypeLookupResourceActionResponseItem", "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": "WorkOrderFailureModeTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->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" } } } }, "WorkOrderFinancialYearPeriodLookupResourceActionResponse": { "title": "WorkOrderFinancialYearPeriodLookupResourceActionResponse", "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": "WorkOrderFinancialYearPeriodLookupResourceActionResponseItem", "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": "WorkOrderFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_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" } } } }, "WorkOrderGeneralLedgerLookupResourceActionResponse": { "title": "WorkOrderGeneralLedgerLookupResourceActionResponse", "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": "WorkOrderGeneralLedgerLookupResourceActionResponseItem", "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": "WorkOrderGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->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" } } } }, "WorkOrderInsertParentWorkOrderLookupResourceActionResponse": { "title": "WorkOrderInsertParentWorkOrderLookupResourceActionResponse", "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": "WorkOrderInsertParentWorkOrderLookupResourceActionResponseItem", "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": "WorkOrderInsertParentWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->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" } } } }, "WorkOrderInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderMergeSourceWorkOrdersAssetLookupResourceActionResponse": { "title": "WorkOrderMergeSourceWorkOrdersAssetLookupResourceActionResponse", "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": "WorkOrderMergeSourceWorkOrdersAssetLookupResourceActionResponseItem", "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": "WorkOrderMergeSourceWorkOrdersAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } } }, "WorkOrderMergeSourceWorkOrdersAssetWorkClassLookupResourceActionResponse": { "title": "WorkOrderMergeSourceWorkOrdersAssetWorkClassLookupResourceActionResponse", "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": "WorkOrderMergeSourceWorkOrdersAssetWorkClassLookupResourceActionResponseItem", "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": "WorkOrderMergeSourceWorkOrdersAssetWorkClassLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } } }, "WorkOrderMergeSourceWorkOrdersAssetTypesOfWorkLookupResourceActionResponse": { "title": "WorkOrderMergeSourceWorkOrdersAssetTypesOfWorkLookupResourceActionResponse", "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": "WorkOrderMergeSourceWorkOrdersAssetTypesOfWorkLookupResourceActionResponseItem", "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": "WorkOrderMergeSourceWorkOrdersAssetTypesOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } } }, "WorkOrderMergeSourceWorkOrdersLookupResourceActionResponse": { "title": "WorkOrderMergeSourceWorkOrdersLookupResourceActionResponse", "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": "WorkOrderMergeSourceWorkOrdersLookupResourceActionResponseItem", "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": "WorkOrderMergeSourceWorkOrdersLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } } }, "WorkOrderMergeSourceWorkOrderWorkClassLookupResourceActionResponse": { "title": "WorkOrderMergeSourceWorkOrderWorkClassLookupResourceActionResponse", "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": "WorkOrderMergeSourceWorkOrderWorkClassLookupResourceActionResponseItem", "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": "WorkOrderMergeSourceWorkOrderWorkClassLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } } }, "WorkOrderMergeSourceWorkOrderTypesOfWorkLookupResourceActionResponse": { "title": "WorkOrderMergeSourceWorkOrderTypesOfWorkLookupResourceActionResponse", "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": "WorkOrderMergeSourceWorkOrderTypesOfWorkLookupResourceActionResponseItem", "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": "WorkOrderMergeSourceWorkOrderTypesOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" } } }, "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" } } } }, "WorkOrderPhone1TypeLookupResourceActionResponse": { "title": "WorkOrderPhone1TypeLookupResourceActionResponse", "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": "WorkOrderPhone1TypeLookupResourceActionResponseItem", "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": "WorkOrderPhone1TypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->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" } } } }, "WorkOrderPhone2TypeLookupResourceActionResponse": { "title": "WorkOrderPhone2TypeLookupResourceActionResponse", "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": "WorkOrderPhone2TypeLookupResourceActionResponseItem", "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": "WorkOrderPhone2TypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->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" } } } }, "WorkOrderRepairTypeForAssetComponentLookupResourceActionResponse": { "title": "WorkOrderRepairTypeForAssetComponentLookupResourceActionResponse", "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": "WorkOrderRepairTypeForAssetComponentLookupResourceActionResponseItem", "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": "WorkOrderRepairTypeForAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->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" } } } }, "WorkOrderRepairTypeLookupResourceActionResponse": { "title": "WorkOrderRepairTypeLookupResourceActionResponse", "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": "WorkOrderRepairTypeLookupResourceActionResponseItem", "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": "WorkOrderRepairTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->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" } } } }, "WorkOrderRequesterContactLookupResourceActionResponse": { "title": "WorkOrderRequesterContactLookupResourceActionResponse", "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": "WorkOrderRequesterContactLookupResourceActionResponseItem", "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": "WorkOrderRequesterContactLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "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" } } } }, "WorkOrderRequisitionLookupResourceActionResponse": { "title": "WorkOrderRequisitionLookupResourceActionResponse", "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": "WorkOrderRequisitionLookupResourceActionResponseItem", "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": "WorkOrderRequisitionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Requisition->Code" } } }, "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" } } } }, "WorkOrderSectionLookupResourceActionResponse": { "title": "WorkOrderSectionLookupResourceActionResponse", "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": "WorkOrderSectionLookupResourceActionResponseItem", "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": "WorkOrderSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "WorkOrderSiteLookupResourceActionResponse": { "title": "WorkOrderSiteLookupResourceActionResponse", "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": "WorkOrderSiteLookupResourceActionResponseItem", "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": "WorkOrderSiteLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStaffMemberLookupResourceActionResponse": { "title": "WorkOrderStaffMemberLookupResourceActionResponse", "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": "WorkOrderStaffMemberLookupResourceActionResponseItem", "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": "WorkOrderStaffMemberLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "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" } } } }, "WorkOrderStatusLookupResourceActionResponse": { "title": "WorkOrderStatusLookupResourceActionResponse", "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": "WorkOrderStatusLookupResourceActionResponseItem", "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": "WorkOrderStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "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" } } } }, "WorkOrderTaskClassification1LookupResourceActionResponse": { "title": "WorkOrderTaskClassification1LookupResourceActionResponse", "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": "WorkOrderTaskClassification1LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification2LookupResourceActionResponse": { "title": "WorkOrderTaskClassification2LookupResourceActionResponse", "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": "WorkOrderTaskClassification2LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification3LookupResourceActionResponse": { "title": "WorkOrderTaskClassification3LookupResourceActionResponse", "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": "WorkOrderTaskClassification3LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification3LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification4LookupResourceActionResponse": { "title": "WorkOrderTaskClassification4LookupResourceActionResponse", "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": "WorkOrderTaskClassification4LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification4LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification5LookupResourceActionResponse": { "title": "WorkOrderTaskClassification5LookupResourceActionResponse", "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": "WorkOrderTaskClassification5LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification5LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification6LookupResourceActionResponse": { "title": "WorkOrderTaskClassification6LookupResourceActionResponse", "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": "WorkOrderTaskClassification6LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification6LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification7LookupResourceActionResponse": { "title": "WorkOrderTaskClassification7LookupResourceActionResponse", "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": "WorkOrderTaskClassification7LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification7LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskClassification8LookupResourceActionResponse": { "title": "WorkOrderTaskClassification8LookupResourceActionResponse", "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": "WorkOrderTaskClassification8LookupResourceActionResponseItem", "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": "WorkOrderTaskClassification8LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTradeLookupResourceActionResponse": { "title": "WorkOrderTradeLookupResourceActionResponse", "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": "WorkOrderTradeLookupResourceActionResponseItem", "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": "WorkOrderTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->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" } } } }, "WorkOrderTypeOfWorkLookupResourceActionResponse": { "title": "WorkOrderTypeOfWorkLookupResourceActionResponse", "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": "WorkOrderTypeOfWorkLookupResourceActionResponseItem", "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": "WorkOrderTypeOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" }, "workType": { "title": "workType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkType", "x-formatSpecifier": "WorkType" } } }, "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" } } } }, "WorkOrderUpdateParentWorkOrderLookupResourceActionResponse": { "title": "WorkOrderUpdateParentWorkOrderLookupResourceActionResponse", "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": "WorkOrderUpdateParentWorkOrderLookupResourceActionResponseItem", "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": "WorkOrderUpdateParentWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->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" } } } }, "WorkOrderWorkClassification1LookupResourceActionResponse": { "title": "WorkOrderWorkClassification1LookupResourceActionResponse", "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": "WorkOrderWorkClassification1LookupResourceActionResponseItem", "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": "WorkOrderWorkClassification1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderWorkClassification2LookupResourceActionResponse": { "title": "WorkOrderWorkClassification2LookupResourceActionResponse", "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": "WorkOrderWorkClassification2LookupResourceActionResponseItem", "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": "WorkOrderWorkClassification2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderWorkClassification3LookupResourceActionResponse": { "title": "WorkOrderWorkClassification3LookupResourceActionResponse", "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": "WorkOrderWorkClassification3LookupResourceActionResponseItem", "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": "WorkOrderWorkClassification3LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderWorkClassification4LookupResourceActionResponse": { "title": "WorkOrderWorkClassification4LookupResourceActionResponse", "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": "WorkOrderWorkClassification4LookupResourceActionResponseItem", "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": "WorkOrderWorkClassification4LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderWorkClassification5LookupResourceActionResponse": { "title": "WorkOrderWorkClassification5LookupResourceActionResponse", "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": "WorkOrderWorkClassification5LookupResourceActionResponseItem", "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": "WorkOrderWorkClassification5LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderWorkOrderImportanceLookupResourceActionResponse": { "title": "WorkOrderWorkOrderImportanceLookupResourceActionResponse", "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": "WorkOrderWorkOrderImportanceLookupResourceActionResponseItem", "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": "WorkOrderWorkOrderImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->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" } } } }, "CreateWorkOrderResourceActionRequest": { "title": "CreateWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requesterType", "workRequired" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "WorkOrder->Asset_Id" }, "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Alarm_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrder->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->PermissionTree_Id", "x-systemGenerated": true }, "assetModificationProposalNumber": { "title": "assetModificationProposalNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationProposalNumber" }, "autoCalculateEstimatedDowntime": { "title": "autoCalculateEstimatedDowntime", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->AutoCalculateEstimatedDowntime" }, "autoCalculateEstimatedDuration": { "title": "autoCalculateEstimatedDuration", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->AutoCalculateEstimatedDuration" }, "completeBy": { "title": "completeBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompleteBy" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompletedOn" }, "contactDescription": { "title": "contactDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ContactDescription" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->CostCentre_Id", "x-systemGenerated": true }, "duration": { "title": "duration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->Duration" }, "email": { "title": "email", "type": "string", "format": "email", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "WorkOrder->Email" }, "estimatedDowntime": { "title": "estimatedDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDowntime" }, "estimatedDuration": { "title": "estimatedDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDuration" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Event_Id" }, "failedComponentId": { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailedComponent_Id", "x-NullExpression": "WorkOrder->Asset_Id eq NULL" }, "analysisComponentId": { "title": "analysisComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->AnalysisComponent_Id" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCause_Id" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureCauseType_Id", "x-NullExpression": "WorkOrder->FailureCause_Id ne NULL" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanism_Id" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureMechanismType_Id", "x-NullExpression": "WorkOrder->FailureMechanism_Id ne NULL" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMode_Id" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureModeType_Id", "x-NullExpression": "WorkOrder->FailureMode_Id ne NULL" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeneralLedger_Id", "x-systemGenerated": true }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->IsPermitRequired" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->MotionType", "x-formatSpecifier": "MotionType" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterContact_Id", "x-NullExpression": "WorkOrder->RequesterType eq 'User'" }, "parentWorkOrderId": { "title": "parentWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->ParentWorkOrder_Id" }, "permitNumber": { "title": "permitNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->PermitNumber" }, "phone1": { "title": "phone1", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1" }, "phone2": { "title": "phone2", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2" }, "phone1TypeId": { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1Type_Id" }, "phone2TypeId": { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2Type_Id" }, "progressPercentage": { "title": "progressPercentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "WorkOrder->ProgressPercentage" }, "receivedOn": { "title": "receivedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ReceivedOn" }, "repairTypeId": { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RepairType_Id" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requester": { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrder->Requester", "x-NullExpression": "WorkOrder->RequesterType eq 'FreeText'", "x-MinLengthExpression": "WorkOrder->RequesterType eq 'FreeText'" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->RequiredBy" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Section_Id" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Id" }, "startOn": { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->StartOn" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification1_Id" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification2_Id" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification3_Id" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification4_Id" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification5_Id" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification6_Id" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification7_Id" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification8_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Trade_Id" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Id" }, "useGlobalLookupLists": { "title": "useGlobalLookupLists", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->UseGlobalLookupLists" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification1_Id" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification2_Id" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification3_Id" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification4_Id" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification5_Id" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkOrderImportance_Id" }, "workPerformed": { "title": "workPerformed", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkPerformed" }, "workRequired": { "title": "workRequired", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->WorkRequired" }, "workStartedOn": { "title": "workStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->WorkStartedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Notes" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkOrder->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderResourceActionRequest": { "title": "UpdateWorkOrderResourceActionRequest", "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": "WorkOrder->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Id" }, { "title": "assetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "WorkOrder->Asset_Id" }, { "title": "alarmId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Alarm_Id" }, { "title": "assetModificationApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationApproved" }, { "title": "assetModificationInvestigated", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationInvestigated" }, { "title": "assetModificationProposalNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationProposalNumber" }, { "title": "autoCalculateEstimatedDowntime", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->AutoCalculateEstimatedDowntime" }, { "title": "autoCalculateEstimatedDuration", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrder->AutoCalculateEstimatedDuration" }, { "title": "completeBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompleteBy" }, { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompletedOn" }, { "title": "contactDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->ContactDescription" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->CostCentre_Id" }, { "title": "email", "type": "string", "format": "email", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "WorkOrder->Email" }, { "title": "estimatedDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDowntime" }, { "title": "estimatedDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDuration" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Event_Id" }, { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailedComponent_Id", "x-NullExpression": "WorkOrder->Asset_Id eq NULL" }, { "title": "analysisComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->AnalysisComponent_Id" }, { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCause_Id" }, { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureCauseType_Id", "x-NullExpression": "WorkOrder->FailureCause_Id ne NULL" }, { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanism_Id" }, { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureMechanismType_Id", "x-NullExpression": "WorkOrder->FailureMechanism_Id ne NULL" }, { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMode_Id" }, { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureModeType_Id", "x-NullExpression": "WorkOrder->FailureMode_Id ne NULL" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeneralLedger_Id" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->IsPermitRequired" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterContact_Id", "x-NullExpression": "WorkOrder->RequesterType eq 'User'" }, { "title": "parentWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->ParentWorkOrder_Id" }, { "title": "permitNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->PermitNumber" }, { "title": "phone1", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1" }, { "title": "phone2", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2" }, { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1Type_Id" }, { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2Type_Id" }, { "title": "progressPercentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "WorkOrder->ProgressPercentage" }, { "title": "receivedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ReceivedOn" }, { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RepairType_Id" }, { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrder->Requester", "x-NullExpression": "WorkOrder->RequesterType eq 'FreeText'", "x-MinLengthExpression": "WorkOrder->RequesterType eq 'FreeText'" }, { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->RequiredBy" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Section_Id" }, { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Id" }, { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->StartOn" }, { "title": "workStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->WorkStartedOn" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification8_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Trade_Id" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Id" }, { "title": "useGlobalLookupLists", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->UseGlobalLookupLists" }, { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification1_Id" }, { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification2_Id" }, { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification3_Id" }, { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification4_Id" }, { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification5_Id" }, { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkOrderImportance_Id" }, { "title": "workPerformed", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkPerformed" }, { "title": "workRequired", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->WorkRequired" }, { "title": "priority", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->Priority" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Notes" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeographicReferenceEntityId" } ] } } }, "BatchGetWorkOrderResourceAction": { "title": "BatchGetWorkOrderResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order entities", "items": { "$ref": "#/definitions/GetWorkOrderResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderResourceActionRequest": { "title": "BatchCreateWorkOrderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderResourceActionRequest" } }, "Requisition": { "title": "Requisition", "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": "Requisition->Code" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Requisition->Notes" }, { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->Importance_Id" }, { "title": "requestTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->RequestType_Id" }, { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Requisition->RequestedOn" }, { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "Requisition->Requester", "x-NullExpression": "Requisition->RequesterType eq 'FreeText'" }, { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Requisition->RequesterContact_Id", "x-NullExpression": "Requisition->RequesterType eq 'User'" }, { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Requisition->RequesterType", "x-formatSpecifier": "RequisitionRequesterType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Requisition->SequenceNumber" }, { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Requisition->WorkOrder_Id" } ] } } }, "BatchUpdateWorkOrderRequisitionResourceActionRequest": { "title": "BatchUpdateWorkOrderRequisitionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/Requisition" } }, "BatchUpdateWorkOrderResourceActionRequest": { "title": "BatchUpdateWorkOrderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderResourceActionRequest" } }, "AddSpareToNewRequisitionForWorkResourceActionRequest": { "title": "AddSpareToNewRequisitionForWorkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AddSpareToNewRequisitionForWorkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requesterType" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Code", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->PermissionTree_Id", "x-systemGenerated": true }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AddSpareToNewRequisition->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Requester" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->RequesterContact_Id" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddSpareToNewRequisition->RequestedOn", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "AddSpareToRequisitionForWorkOrderResourceActionRequest": { "title": "AddSpareToRequisitionForWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AddSpareToRequisitionForWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requisitionId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AddSpareToRequisition->Requisition_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAddSpareToNewRequisitionForWorkOrderResourceActionRequest": { "title": "BatchAddSpareToNewRequisitionForWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchAddSpareToNewRequisitionForWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds", "requesterType", "requestedOn" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "AddSpareToNewRequisition->EntityIds", "x-formatSpecifier": "Int64" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->PermissionTree_Id", "x-systemGenerated": true }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AddSpareToNewRequisition->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Requester" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->RequesterContact_Id" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddSpareToNewRequisition->RequestedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "AlignWorkOrderTasksWithAssetTasksResourceActionRequest": { "title": "AlignWorkOrderTasksWithAssetTasksResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AlignWorkOrderTasksWithAssetTasksResourceActionRequestProperties", "type": "object", "x-nullable": false }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAlignWorkOrderTasksWithAssetTasksResourceActionRequest": { "title": "BatchAlignWorkOrderTasksWithAssetTasksResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/AlignWorkOrderTasksWithAssetTasksResourceActionRequest" } }, "BatchCompleteAllTasksResourceActionRequest": { "title": "BatchCompleteAllTasksResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchCompleteAllTasksResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "workOrderIds": { "title": "workOrderIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "CompleteAllTasksForWorkOrders->WorkOrderIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchIssueAllWorkOrderResourceActionRequest": { "title": "BatchIssueAllWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchIssueAllWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchReturnAllWorkOrderResourceActionRequest": { "title": "BatchReturnAllWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchReturnAllWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "CalculateWorkOrderPriorityResourceActionRequest": { "title": "CalculateWorkOrderPriorityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CalculateWorkOrderPriorityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeWorkOrderPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderPermissionTreeResourceActionRequest", "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": "WorkOrder->PermissionTree_Id" } ] } } }, "ForceWorkOrderServiceLevelAgreementProgressCalculationResourceActionRequest": { "title": "ForceWorkOrderServiceLevelAgreementProgressCalculationResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ForceWorkOrderServiceLevelAgreementProgressCalculationResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "workOrderIds": { "title": "workOrderIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "ForceWorkOrderServiceLevelAgreementProgressCalculation->WorkOrderIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ForceWorkOrderServiceLevelAgreementReassignmentResourceActionRequest": { "title": "ForceWorkOrderServiceLevelAgreementReassignmentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ForceWorkOrderServiceLevelAgreementReassignmentResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "workOrderIds": { "title": "workOrderIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "ForceWorkOrderServiceLevelAgreementReassignment->WorkOrderIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "IssueAllWorkOrderResourceActionRequest": { "title": "IssueAllWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "IssueAllWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ReturnAllWorkOrderResourceActionRequest": { "title": "ReturnAllWorkOrderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ReturnAllWorkOrderResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "WorkOrderSetProgressResourceActionRequest": { "title": "WorkOrderSetProgressResourceActionRequest", "type": "object", "properties": { "properties": { "title": "WorkOrderSetProgressResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderSetProgress->ExecutedOn" }, "freeTextReason": { "title": "freeTextReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->FreeTextReason" }, "reasonId": { "title": "reasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->Reason_Id" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkOrderSetProgress->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderSetProgress->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderSetProgress->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderSetProgress->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeWorkOrderStatusResourceActionRequest": { "title": "ChangeWorkOrderStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ChangeWorkOrderStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderId", "statusId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChange->WorkOrder_Id" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChange->Status_Id" }, "offlineStatusChangedOn": { "title": "offlineStatusChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusChange->OfflineStatusChangedOn" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChange->Remark" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "WorkOrderMergeResourceActionRequest": { "title": "WorkOrderMergeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "WorkOrderMergeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "targetWorkOrderId", "sourceWorkOrderIds" ], "properties": { "targetWorkOrderId": { "title": "targetWorkOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderMerge->TargetWorkOrderId" }, "sourceWorkOrderIds": { "title": "sourceWorkOrderIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "WorkOrderMerge->SourceWorkOrderIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchWorkOrderMergeResourceActionRequest": { "title": "BatchWorkOrderMergeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/WorkOrderMergeResourceActionRequest" } }, "WorkOrderSplitResourceActionRequest": { "title": "WorkOrderSplitResourceActionRequest", "type": "object", "properties": { "properties": { "title": "WorkOrderSplitResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "sourceWorkOrderId", "targetWorkOrderTaskIds" ], "properties": { "sourceWorkOrderId": { "title": "sourceWorkOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderSplit->SourceWorkOrderId" }, "targetWorkOrderTaskIds": { "title": "targetWorkOrderTaskIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "WorkOrderSplit->TargetWorkOrderTaskIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeWorkOrderPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderPermissionTreeResourceActionRequest" } }, "BatchChangeWorkOrderStatusResourceActionRequest": { "title": "BatchChangeWorkOrderStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusResourceActionRequest" } }, "BatchWorkOrderSplitResourceActionRequest": { "title": "BatchWorkOrderSplitResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/WorkOrderSplitResourceActionRequest" } }, "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 } } }, "MatchUpdateWorkOrderResourceActionRequest": { "title": "MatchUpdateWorkOrderResourceActionRequest", "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": "workRequired", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->WorkRequired" }, { "title": "workPerformed", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkPerformed" }, { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RequesterContact_Id", "x-NullExpression": "WorkOrder->RequesterType eq 'User'" }, { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrder->Requester", "x-NullExpression": "WorkOrder->RequesterType eq 'FreeText'", "x-MinLengthExpression": "WorkOrder->RequesterType eq 'FreeText'" }, { "title": "phone1", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1" }, { "title": "phone2", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2" }, { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone1Type_Id" }, { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Phone2Type_Id" }, { "title": "email", "type": "string", "format": "email", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "WorkOrder->Email" }, { "title": "receivedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ReceivedOn" }, { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->RequiredBy" }, { "title": "parentWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->ParentWorkOrder_Id" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->TypeOfWork_Id" }, { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkOrderImportance_Id" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->IsPermitRequired" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Event_Id" }, { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->StartOn" }, { "title": "completeBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompleteBy" }, { "title": "estimatedDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDuration" }, { "title": "estimatedDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrder->EstimatedDowntime" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Trade_Id" }, { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->GeneralLedger_Id" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->CostCentre_Id" }, { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->CompletedOn" }, { "title": "progressPercentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "WorkOrder->ProgressPercentage" }, { "title": "permitNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->PermitNumber" }, { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureMechanismType_Id", "x-NullExpression": "WorkOrder->FailureMechanism_Id ne NULL" }, { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureMechanism_Id" }, { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrder->FailureCauseType_Id", "x-NullExpression": "WorkOrder->FailureCause_Id ne NULL" }, { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->FailureCause_Id" }, { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->RepairType_Id" }, { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification1_Id" }, { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification2_Id" }, { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification3_Id" }, { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification4_Id" }, { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->WorkClassification5_Id" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TaskClassification8_Id" }, { "title": "assetModificationApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationApproved" }, { "title": "assetModificationInvestigated", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrder->AssetModificationInvestigated" }, { "title": "assetModificationProposalNumber", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->AssetModificationProposalNumber" }, { "title": "priority", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrder->Priority" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Notes" } ] } } }, "GetWorkOrderAttributeResourceActionResponse": { "title": "GetWorkOrderAttributeResourceActionResponse", "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": "GetWorkOrderAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->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" } } }, "GetWorkOrderAttributeCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderAttributeCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderAttributeCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderAttributeCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderAttribute->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" } } } }, "GetWorkOrderAttributeCollectionResourceActionResponse": { "title": "GetWorkOrderAttributeCollectionResourceActionResponse", "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": "GetWorkOrderAttributeCollectionResourceActionResponseItem", "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": "GetWorkOrderAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderAttribute->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" } } } }, "WorkOrderAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "WorkOrderAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "WorkOrderAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "WorkOrderAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderAttributeAttributeLookupResourceActionResponse": { "title": "WorkOrderAttributeAttributeLookupResourceActionResponse", "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": "WorkOrderAttributeAttributeLookupResourceActionResponseItem", "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": "WorkOrderAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderAttributeChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderAttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderAttributeWorkOrderLookupResourceActionResponse": { "title": "WorkOrderAttributeWorkOrderLookupResourceActionResponse", "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": "WorkOrderAttributeWorkOrderLookupResourceActionResponseItem", "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": "WorkOrderAttributeWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->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" } } } }, "CreateWorkOrderAttributeResourceActionRequest": { "title": "CreateWorkOrderAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderId", "attributeId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->WorkOrder_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderAttributeResourceActionRequest": { "title": "UpdateWorkOrderAttributeResourceActionRequest", "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": "WorkOrderAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderAttribute->Notes" } ] } } }, "DeleteWorkOrderAttributeResourceActionRequest": { "title": "DeleteWorkOrderAttributeResourceActionRequest", "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 } } }, "BatchGetWorkOrderAttributeResourceAction": { "title": "BatchGetWorkOrderAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Attribute entities", "items": { "$ref": "#/definitions/GetWorkOrderAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderAttributeResourceActionRequest": { "title": "BatchCreateWorkOrderAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderAttributeResourceActionRequest" } }, "BatchUpdateWorkOrderAttributeResourceActionRequest": { "title": "BatchUpdateWorkOrderAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderAttributeResourceActionRequest" } }, "BatchDeleteWorkOrderAttributeResourceActionRequest": { "title": "BatchDeleteWorkOrderAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderAttributeResourceActionRequest" } }, "ChangeWorkOrderAttributeIsActiveResourceActionRequest": { "title": "ChangeWorkOrderAttributeIsActiveResourceActionRequest", "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": "WorkOrderAttribute->IsActive" } ] } } }, "ChangeWorkOrderAttributePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderAttributePermissionTreeResourceActionRequest", "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": "WorkOrderAttribute->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderAttributePermissionTreeResourceActionRequest" } }, "BatchChangeWorkOrderAttributeIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderAttributeIsActiveResourceActionRequest" } }, "GetWorkOrderCompleteAllTasksLogResourceActionResponse": { "title": "GetWorkOrderCompleteAllTasksLogResourceActionResponse", "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": "GetWorkOrderCompleteAllTasksLogResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderCompleteAllTasksLog->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->PermissionTree_Description" }, "batchId": { "title": "batchId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->BatchId" }, "result": { "title": "result", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->Result" }, "wasSuccessful": { "title": "wasSuccessful", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WasSuccessful" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Description" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription" } } }, "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" } } }, "GetWorkOrderCompleteAllTasksLogCollectionResourceActionResponse": { "title": "GetWorkOrderCompleteAllTasksLogCollectionResourceActionResponse", "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": "GetWorkOrderCompleteAllTasksLogCollectionResourceActionResponseItem", "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": "GetWorkOrderCompleteAllTasksLogCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "batchId": { "title": "batchId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->BatchId" }, "result": { "title": "result", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->Result" }, "wasSuccessful": { "title": "wasSuccessful", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WasSuccessful" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Description" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription" } } }, "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" } } } }, "GetWorkOrderCompleteAllTasksLogForBatchCollectionResourceActionResponse": { "title": "GetWorkOrderCompleteAllTasksLogForBatchCollectionResourceActionResponse", "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": "GetWorkOrderCompleteAllTasksLogForBatchCollectionResourceActionResponseItem", "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": "GetWorkOrderCompleteAllTasksLogForBatchCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "result": { "title": "result", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->Result" }, "wasSuccessful": { "title": "wasSuccessful", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WasSuccessful" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrder_Description" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderCompleteAllTasksLog->WorkOrderTask_TaskDescription" } } }, "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" } } } }, "BatchGetWorkOrderCompleteAllTasksLogResourceAction": { "title": "BatchGetWorkOrderCompleteAllTasksLogResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Complete All Tasks Log entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Complete All Tasks Log entities", "items": { "$ref": "#/definitions/GetWorkOrderCompleteAllTasksLogResourceActionResponse" } }, "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" } } }, "GetWorkOrderDocumentResourceActionResponse": { "title": "GetWorkOrderDocumentResourceActionResponse", "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": "GetWorkOrderDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isCopiedDocumentLink": { "title": "isCopiedDocumentLink", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->IsCopiedDocumentLink" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->WorkOrder_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->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" } } }, "GetWorkOrderDocumentCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderDocumentCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderDocumentCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderDocumentCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileType_Extension" }, "isCopiedDocumentLink": { "title": "isCopiedDocumentLink", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->IsCopiedDocumentLink" } } }, "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" } } } }, "GetWorkOrderDocumentCollectionResourceActionResponse": { "title": "GetWorkOrderDocumentCollectionResourceActionResponse", "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": "GetWorkOrderDocumentCollectionResourceActionResponseItem", "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": "GetWorkOrderDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->WorkOrder_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->DocumentRecord_FileType_Extension" }, "isCopiedDocumentLink": { "title": "isCopiedDocumentLink", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->IsCopiedDocumentLink" } } }, "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" } } } }, "WorkOrderDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderDocumentChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderDocumentDocumentLookupResourceActionResponse": { "title": "WorkOrderDocumentDocumentLookupResourceActionResponse", "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": "WorkOrderDocumentDocumentLookupResourceActionResponseItem", "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": "WorkOrderDocumentDocumentLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "WorkOrderDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderDocumentWorkOrderLookupResourceActionResponse": { "title": "WorkOrderDocumentWorkOrderLookupResourceActionResponse", "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": "WorkOrderDocumentWorkOrderLookupResourceActionResponseItem", "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": "WorkOrderDocumentWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->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" } } } }, "CreateWorkOrderDocumentResourceActionRequest": { "title": "CreateWorkOrderDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderId", "documentRecordId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->WorkOrder_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderDocumentResourceActionRequest": { "title": "UpdateWorkOrderDocumentResourceActionRequest", "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": "WorkOrderDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDocument->Notes" } ] } } }, "DeleteWorkOrderDocumentResourceActionRequest": { "title": "DeleteWorkOrderDocumentResourceActionRequest", "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 } } }, "BatchGetWorkOrderDocumentResourceAction": { "title": "BatchGetWorkOrderDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Document entities", "items": { "$ref": "#/definitions/GetWorkOrderDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderDocumentResourceActionRequest": { "title": "BatchCreateWorkOrderDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderDocumentResourceActionRequest" } }, "BatchUpdateWorkOrderDocumentResourceActionRequest": { "title": "BatchUpdateWorkOrderDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderDocumentResourceActionRequest" } }, "BatchDeleteWorkOrderDocumentResourceActionRequest": { "title": "BatchDeleteWorkOrderDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderDocumentResourceActionRequest" } }, "ChangeWorkOrderDocumentIsActiveResourceActionRequest": { "title": "ChangeWorkOrderDocumentIsActiveResourceActionRequest", "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": "WorkOrderDocument->IsActive" } ] } } }, "ChangeWorkOrderDocumentPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderDocumentPermissionTreeResourceActionRequest", "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": "WorkOrderDocument->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeWorkOrderDocumentIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderDocumentIsActiveResourceActionRequest" } }, "GetWorkOrderDowntimeLossResourceActionResponse": { "title": "GetWorkOrderDowntimeLossResourceActionResponse", "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": "GetWorkOrderDowntimeLossResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->PermissionTree_Description" }, "downFrom": { "title": "downFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownFrom" }, "downTo": { "title": "downTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownTo" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderDowntimeLoss->Duration" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->Notes" }, "timeLossReasonId": { "title": "timeLossReasonId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Id" }, "timeLossReasonCode": { "title": "timeLossReasonCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Code" }, "timeLossReasonDescription": { "title": "timeLossReasonDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Id" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Code" } } }, "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" } } }, "GetWorkOrderDowntimeLossCollectionResourceActionResponse": { "title": "GetWorkOrderDowntimeLossCollectionResourceActionResponse", "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": "GetWorkOrderDowntimeLossCollectionResourceActionResponseItem", "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": "GetWorkOrderDowntimeLossCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Description" }, "timeLossReasonId": { "title": "timeLossReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Id" }, "timeLossReasonCode": { "title": "timeLossReasonCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Code" }, "timeLossReasonDescription": { "title": "timeLossReasonDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Description" }, "downFrom": { "title": "downFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownFrom" }, "downTo": { "title": "downTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownTo" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderDowntimeLoss->Duration" } } }, "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" } } } }, "GetWorkOrderDowntimeLossForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderDowntimeLossForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderDowntimeLossForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderDowntimeLossForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Description" }, "timeLossReasonCode": { "title": "timeLossReasonCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Code" }, "timeLossReasonDescription": { "title": "timeLossReasonDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Description" }, "downFrom": { "title": "downFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownFrom" }, "downTo": { "title": "downTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownTo" }, "duration": { "title": "duration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderDowntimeLoss->Duration" } } }, "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" } } } }, "WorkOrderDowntimeLossChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderDowntimeLossChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderDowntimeLossChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderDowntimeLossChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderDowntimeLossInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderDowntimeLossInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderDowntimeLossInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderDowntimeLossInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderDowntimeLossTimeLossReasonLookupResourceActionResponse": { "title": "WorkOrderDowntimeLossTimeLossReasonLookupResourceActionResponse", "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": "WorkOrderDowntimeLossTimeLossReasonLookupResourceActionResponseItem", "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": "WorkOrderDowntimeLossTimeLossReasonLookupResourceActionResponseItemProperties", "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" } } }, "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" } } } }, "WorkOrderDowntimeLossWorkOrderLookupResourceActionResponse": { "title": "WorkOrderDowntimeLossWorkOrderLookupResourceActionResponse", "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": "WorkOrderDowntimeLossWorkOrderLookupResourceActionResponseItem", "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": "WorkOrderDowntimeLossWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "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" } } } }, "CreateWorkOrderDowntimeLossResourceActionRequest": { "title": "CreateWorkOrderDowntimeLossResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderDowntimeLossResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "downFrom", "downTo", "timeLossReasonId", "workOrderId" ], "properties": { "downFrom": { "title": "downFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownFrom" }, "downTo": { "title": "downTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownTo" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->PermissionTree_Id", "x-systemGenerated": true }, "timeLossReasonId": { "title": "timeLossReasonId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Id" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderDowntimeLossResourceActionRequest": { "title": "UpdateWorkOrderDowntimeLossResourceActionRequest", "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": "WorkOrderDowntimeLoss->PermissionTree_Id" }, { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->WorkOrder_Id" }, { "title": "timeLossReasonId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderDowntimeLoss->TimeLossReason_Id" }, { "title": "downFrom", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownFrom" }, { "title": "downTo", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderDowntimeLoss->DownTo" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderDowntimeLoss->Notes" } ] } } }, "DeleteWorkOrderDowntimeLossResourceActionRequest": { "title": "DeleteWorkOrderDowntimeLossResourceActionRequest", "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 } } }, "BatchGetWorkOrderDowntimeLossResourceAction": { "title": "BatchGetWorkOrderDowntimeLossResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Downtime Loss entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Downtime Loss entities", "items": { "$ref": "#/definitions/GetWorkOrderDowntimeLossResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderDowntimeLossResourceActionRequest": { "title": "BatchCreateWorkOrderDowntimeLossResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderDowntimeLossResourceActionRequest" } }, "BatchUpdateWorkOrderDowntimeLossResourceActionRequest": { "title": "BatchUpdateWorkOrderDowntimeLossResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderDowntimeLossResourceActionRequest" } }, "BatchDeleteWorkOrderDowntimeLossResourceActionRequest": { "title": "BatchDeleteWorkOrderDowntimeLossResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderDowntimeLossResourceActionRequest" } }, "ChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest", "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": "WorkOrderDowntimeLoss->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderDowntimeLossPermissionTreeResourceActionRequest" } }, "GetWorkOrderFileAttachmentResourceActionResponse": { "title": "GetWorkOrderFileAttachmentResourceActionResponse", "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": "GetWorkOrderFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "WorkOrderFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_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" } } }, "GetWorkOrderFileAttachmentCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderFileAttachmentCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderFileAttachmentCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderFileAttachmentCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderFileAttachment->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" } } } }, "GetWorkOrderFileAttachmentCollectionResourceActionResponse": { "title": "GetWorkOrderFileAttachmentCollectionResourceActionResponse", "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": "GetWorkOrderFileAttachmentCollectionResourceActionResponseItem", "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": "GetWorkOrderFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderFileAttachment->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" } } } }, "CreateWorkOrderFileAttachmentResourceActionRequest": { "title": "CreateWorkOrderFileAttachmentResourceActionRequest", "type": "object", "required": [ "workOrderId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkOrderFileAttachmentContentResourceActionRequest": { "title": "UpdateWorkOrderFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkOrderFileAttachmentResourceActionRequest": { "title": "UpdateWorkOrderFileAttachmentResourceActionRequest", "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": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsRestricted" } ] } } }, "DeleteWorkOrderFileAttachmentResourceResourceActionRequest": { "title": "DeleteWorkOrderFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetWorkOrderFileAttachmentResourceAction": { "title": "BatchGetWorkOrderFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order File Attachment entities", "items": { "$ref": "#/definitions/GetWorkOrderFileAttachmentResourceActionResponse" } }, "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" } } }, "GetWorkOrderFileAttachmentContentHistoryResourceActionResponse": { "title": "GetWorkOrderFileAttachmentContentHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetWorkOrderFileAttachmentContentHistoryResourceAction": { "title": "GetWorkOrderFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order File Attachment entities", "items": { "$ref": "#/definitions/GetWorkOrderFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderFileAttachmentResourceActionRequest": { "title": "BatchCreateWorkOrderFileAttachmentResourceActionRequest", "type": "object", "required": [ "workOrderId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->WorkOrder_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateWorkOrderFileAttachmentResourceActionRequest": { "title": "BatchUpdateWorkOrderFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderFileAttachmentResourceActionRequest" } }, "BatchDeleteWorkOrderFileAttachmentResourceActionRequest": { "title": "BatchDeleteWorkOrderFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderFileAttachmentResourceResourceActionRequest" } }, "GetWorkOrderImportanceResourceActionResponse": { "title": "GetWorkOrderImportanceResourceActionResponse", "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": "GetWorkOrderImportanceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderImportance->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderImportance->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->SequenceNumber" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Weight" } } }, "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" } } }, "GetWorkOrderImportanceCollectionResourceActionResponse": { "title": "GetWorkOrderImportanceCollectionResourceActionResponse", "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": "GetWorkOrderImportanceCollectionResourceActionResponseItem", "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": "GetWorkOrderImportanceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->SequenceNumber" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Weight" } } }, "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" } } } }, "WorkOrderImportanceChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderImportanceChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderImportanceChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderImportanceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderImportanceInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderImportanceInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderImportanceInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderImportanceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateWorkOrderImportanceResourceActionRequest": { "title": "CreateWorkOrderImportanceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderImportanceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "weight" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->SequenceNumber" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Weight" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderImportanceResourceActionRequest": { "title": "UpdateWorkOrderImportanceResourceActionRequest", "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": "WorkOrderImportance->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->Notes" }, { "title": "weight", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Weight" } ] } } }, "DeleteWorkOrderImportanceResourceActionRequest": { "title": "DeleteWorkOrderImportanceResourceActionRequest", "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 } } }, "BatchGetWorkOrderImportanceResourceAction": { "title": "BatchGetWorkOrderImportanceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Importance entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Importance entities", "items": { "$ref": "#/definitions/GetWorkOrderImportanceResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderImportanceResourceActionRequest": { "title": "BatchCreateWorkOrderImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderImportanceResourceActionRequest" } }, "BatchUpdateWorkOrderImportanceResourceActionRequest": { "title": "BatchUpdateWorkOrderImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderImportanceResourceActionRequest" } }, "BatchDeleteWorkOrderImportanceResourceActionRequest": { "title": "BatchDeleteWorkOrderImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderImportanceResourceActionRequest" } }, "ChangeWorkOrderImportanceIsActiveResourceActionRequest": { "title": "ChangeWorkOrderImportanceIsActiveResourceActionRequest", "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": "WorkOrderImportance->IsActive" } ] } } }, "ChangeWorkOrderImportancePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderImportancePermissionTreeResourceActionRequest", "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": "WorkOrderImportance->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderImportanceIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderImportanceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderImportanceIsActiveResourceActionRequest" } }, "BatchChangeWorkOrderImportancePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderImportancePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderImportancePermissionTreeResourceActionRequest" } }, "MatchUpdateWorkOrderImportanceResourceActionRequest": { "title": "MatchUpdateWorkOrderImportanceResourceActionRequest", "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": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderImportance->Notes" } ] } } }, "GetWorkOrderMeterResourceActionResponse": { "title": "GetWorkOrderMeterResourceActionResponse", "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": "GetWorkOrderMeterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->CreatedOn" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_Code" }, "meterLastReading": { "title": "meterLastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_LastReading" }, "meterAverageDailyRate": { "title": "meterAverageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_AverageDailyRate" }, "meterCumulativeReading": { "title": "meterCumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_CumulativeReading" }, "meterLastReadOn": { "title": "meterLastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->Meter_LastReadOn" }, "meterNotes": { "title": "meterNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_Notes" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_Description" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->MeterReading_Id" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->ReadingOn" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ReadingValue" }, "scheduledDate": { "title": "scheduledDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderMeter->ScheduledDate" }, "scheduledMeterReading": { "title": "scheduledMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledMeterReading" }, "scheduledWorkOrderTaskId": { "title": "scheduledWorkOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_Id" }, "scheduledWorkOrderTaskAssetTreePathId": { "title": "scheduledWorkOrderTaskAssetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_AssetTreePathId" }, "scheduledWorkOrderTaskAssetTreePathItems": { "title": "scheduledWorkOrderTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_AssetTreePathItems", "x-formatSpecifier": "TreePathItem" }, "scheduledWorkOrderTaskCompleted": { "title": "scheduledWorkOrderTaskCompleted", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_Completed" }, "scheduledWorkOrderTaskComponentTreePathId": { "title": "scheduledWorkOrderTaskComponentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_ComponentTreePathId" }, "scheduledWorkOrderTaskComponentTreePathItems": { "title": "scheduledWorkOrderTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_ComponentTreePathItems", "x-formatSpecifier": "TreePathItem" }, "scheduledWorkOrderTaskTaskCode": { "title": "scheduledWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_TaskCode" }, "scheduledWorkOrderTaskTaskDescription": { "title": "scheduledWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_TaskDescription" }, "scheduledWorkOrderTaskTaskType": { "title": "scheduledWorkOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledWorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->WorkOrder_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" } } }, "GetWorkOrderMeterCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderMeterCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderMeterCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderMeterCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->Meter_Description" }, "meterLastReading": { "title": "meterLastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_LastReading" }, "meterLastReadOn": { "title": "meterLastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->Meter_LastReadOn" }, "scheduledDate": { "title": "scheduledDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderMeter->ScheduledDate" }, "scheduledMeterReading": { "title": "scheduledMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledMeterReading" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ReadingValue" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->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" } } } }, "GetWorkOrderMeterCollectionResourceActionResponse": { "title": "GetWorkOrderMeterCollectionResourceActionResponse", "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": "GetWorkOrderMeterCollectionResourceActionResponseItem", "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": "GetWorkOrderMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->WorkOrder_Code" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->Meter_Code" }, "meterNotes": { "title": "meterNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_Notes" }, "meterLastReading": { "title": "meterLastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_LastReading" }, "meterLastReadOn": { "title": "meterLastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->Meter_LastReadOn" }, "meterAverageDailyRate": { "title": "meterAverageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->Meter_AverageDailyRate" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMeter->Meter_Description" }, "scheduledDate": { "title": "scheduledDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderMeter->ScheduledDate" }, "scheduledMeterReading": { "title": "scheduledMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ScheduledMeterReading" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ReadingValue" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->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" } } } }, "UpdateWorkOrderMeterResourceActionRequest": { "title": "UpdateWorkOrderMeterResourceActionRequest", "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": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMeter->ReadingValue" }, { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMeter->ReadingOn" } ] } } }, "BatchGetWorkOrderMeterResourceAction": { "title": "BatchGetWorkOrderMeterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Meter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Meter entities", "items": { "$ref": "#/definitions/GetWorkOrderMeterResourceActionResponse" } }, "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" } } }, "BatchUpdateWorkOrderMeterResourceActionRequest": { "title": "BatchUpdateWorkOrderMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderMeterResourceActionRequest" } }, "ValidateWorkOrderMeterAdrResourceActionRequest": { "title": "ValidateWorkOrderMeterAdrResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ValidateWorkOrderMeterAdrResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderId", "meterId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ValidateWMMeterAdrEntity->WorkOrder_Id" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ValidateWMMeterAdrEntity->Meter_Id" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ValidateWMMeterAdrEntity->MeterReading_Id" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ValidateWMMeterAdrEntity->ReadingValue" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ValidateWMMeterAdrEntity->ReadingOn" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GetWorkOrderMonitoringPointResourceActionResponse": { "title": "GetWorkOrderMonitoringPointResourceActionResponse", "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": "GetWorkOrderMonitoringPointResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Description" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->LowerCriticalBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->LowerWarningBound" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Description" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingDate" }, "monitoringPointReadingValue": { "title": "monitoringPointReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingValue", "x-NullExpression": "WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->Notes" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->UpperWarningBound" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_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" } } }, "GetWorkOrderMonitoringPointCollectionResourceActionResponse": { "title": "GetWorkOrderMonitoringPointCollectionResourceActionResponse", "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": "GetWorkOrderMonitoringPointCollectionResourceActionResponseItem", "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": "GetWorkOrderMonitoringPointCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Description" }, "monitoringPointReadingValue": { "title": "monitoringPointReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingValue", "x-NullExpression": "WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Description" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingDate" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_Status_Description" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->UpperWarningBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->LowerWarningBound" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->LowerCriticalBound" } } }, "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" } } } }, "GetWorkOrderMonitoringPointForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderMonitoringPointForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderMonitoringPointForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderMonitoringPointForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Description" }, "monitoringPointReadingValue": { "title": "monitoringPointReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingValue", "x-NullExpression": "WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Code" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingDate" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->UpperWarningBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->LowerWarningBound" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->LowerCriticalBound" } } }, "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" } } } }, "WorkOrderMonitoringPointChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderMonitoringPointChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderMonitoringPointChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderMonitoringPointChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderMonitoringPointInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderMonitoringPointInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderMonitoringPointInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderMonitoringPointInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateWorkOrderMonitoringPointResourceActionRequest": { "title": "CreateWorkOrderMonitoringPointResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderMonitoringPointResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "monitoringPointId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->WorkOrder_Id", "x-systemGenerated": true }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPoint_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->PermissionTree_Id", "x-systemGenerated": true }, "monitoringPointReadingValue": { "title": "monitoringPointReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingValue", "x-NullExpression": "WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingDate" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderMonitoringPointResourceActionRequest": { "title": "UpdateWorkOrderMonitoringPointResourceActionRequest", "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": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMonitoringPoint->Notes" }, { "title": "monitoringPointReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingValue", "x-NullExpression": "WorkOrderMonitoringPoint->MonitoringPointReadingDate ne null" }, { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMonitoringPoint->MonitoringPointReadingDate" } ] } } }, "BatchGetWorkOrderMonitoringPointResourceAction": { "title": "BatchGetWorkOrderMonitoringPointResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Monitoring Point entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Monitoring Point entities", "items": { "$ref": "#/definitions/GetWorkOrderMonitoringPointResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderMonitoringPointResourceActionRequest": { "title": "BatchCreateWorkOrderMonitoringPointResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderMonitoringPointResourceActionRequest" } }, "BatchUpdateWorkOrderMonitoringPointResourceActionRequest": { "title": "BatchUpdateWorkOrderMonitoringPointResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderMonitoringPointResourceActionRequest" } }, "ChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest", "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": "WorkOrderMonitoringPoint->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderMonitoringPointPermissionTreeResourceActionRequest" } }, "GetWorkOrderMovementResourceActionResponse": { "title": "GetWorkOrderMovementResourceActionResponse", "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": "GetWorkOrderMovementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMovement->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->PermissionTree_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->WorkOrder_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" } } }, "GetWorkOrderMovementCollectionResourceActionResponse": { "title": "GetWorkOrderMovementCollectionResourceActionResponse", "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": "GetWorkOrderMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMovement->WorkOrder_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderMovement->CreatedOn" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderMovement->CreatedByUser_FullName" } } }, "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" } } } }, "BatchGetWorkOrderMovementResourceAction": { "title": "BatchGetWorkOrderMovementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Movement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Movement entities", "items": { "$ref": "#/definitions/GetWorkOrderMovementResourceActionResponse" } }, "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" } } }, "GetWorkOrderProgressEventResourceActionResponse": { "title": "GetWorkOrderProgressEventResourceActionResponse", "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": "GetWorkOrderProgressEventResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEvent->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEvent->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->PermissionTree_Description" }, "allowAsFirstEvent": { "title": "allowAsFirstEvent", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->AllowAsFirstEvent" }, "applyEventRestrictions": { "title": "applyEventRestrictions", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ApplyEventRestrictions" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Description" }, "reasonRequired": { "title": "reasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ReasonRequired" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->SequenceNumber" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Code" }, "workOrderStatusBaseStatus": { "title": "workOrderStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Description" }, "workOrderStatusSequenceNumber": { "title": "workOrderStatusSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_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" } } }, "GetWorkOrderProgressEventCollectionResourceActionResponse": { "title": "GetWorkOrderProgressEventCollectionResourceActionResponse", "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": "GetWorkOrderProgressEventCollectionResourceActionResponseItem", "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": "GetWorkOrderProgressEventCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->SequenceNumber" }, "reasonRequired": { "title": "reasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ReasonRequired" }, "applyEventRestrictions": { "title": "applyEventRestrictions", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ApplyEventRestrictions" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Description" }, "workOrderStatusBaseStatus": { "title": "workOrderStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEvent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEvent->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" } } } }, "WorkOrderProgressEventChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderProgressEventChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderProgressEventChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderProgressEventChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderProgressEventInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderProgressEventInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderProgressEventInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderProgressEventInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderProgressEventWorkOrderStatusLookupResourceActionResponse": { "title": "WorkOrderProgressEventWorkOrderStatusLookupResourceActionResponse", "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": "WorkOrderProgressEventWorkOrderStatusLookupResourceActionResponseItem", "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": "WorkOrderProgressEventWorkOrderStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "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" } } } }, "CreateWorkOrderProgressEventResourceActionRequest": { "title": "CreateWorkOrderProgressEventResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderProgressEventResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z]*$", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->SequenceNumber" }, "reasonRequired": { "title": "reasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ReasonRequired" }, "allowAsFirstEvent": { "title": "allowAsFirstEvent", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->AllowAsFirstEvent" }, "applyEventRestrictions": { "title": "applyEventRestrictions", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ApplyEventRestrictions" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderProgressEventResourceActionRequest": { "title": "UpdateWorkOrderProgressEventResourceActionRequest", "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, "pattern": "^[a-zA-Z]*$", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->SequenceNumber" }, { "title": "reasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ReasonRequired" }, { "title": "allowAsFirstEvent", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->AllowAsFirstEvent" }, { "title": "applyEventRestrictions", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->ApplyEventRestrictions" }, { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->WorkOrderStatus_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEvent->Notes" } ] } } }, "DeleteWorkOrderProgressEventResourceActionRequest": { "title": "DeleteWorkOrderProgressEventResourceActionRequest", "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 } } }, "BatchGetWorkOrderProgressEventResourceAction": { "title": "BatchGetWorkOrderProgressEventResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Progress Event entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Progress Event entities", "items": { "$ref": "#/definitions/GetWorkOrderProgressEventResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderProgressEventResourceActionRequest": { "title": "BatchCreateWorkOrderProgressEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderProgressEventResourceActionRequest" } }, "BatchUpdateWorkOrderProgressEventResourceActionRequest": { "title": "BatchUpdateWorkOrderProgressEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderProgressEventResourceActionRequest" } }, "BatchDeleteWorkOrderProgressEventResourceActionRequest": { "title": "BatchDeleteWorkOrderProgressEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderProgressEventResourceActionRequest" } }, "ChangeWorkOrderProgressEventIsActiveResourceActionRequest": { "title": "ChangeWorkOrderProgressEventIsActiveResourceActionRequest", "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": "WorkOrderProgressEvent->IsActive" } ] } } }, "ChangeWorkOrderProgressEventPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderProgressEventPermissionTreeResourceActionRequest", "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": "WorkOrderProgressEvent->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderProgressEventIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderProgressEventIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderProgressEventIsActiveResourceActionRequest" } }, "BatchChangeWorkOrderProgressEventPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderProgressEventPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderProgressEventPermissionTreeResourceActionRequest" } }, "GetWorkOrderProgressEventAllowedChangeResourceActionResponse": { "title": "GetWorkOrderProgressEventAllowedChangeResourceActionResponse", "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": "GetWorkOrderProgressEventAllowedChangeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEventAllowedChange->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEventAllowedChange->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->SequenceNumber" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Description" }, "allowedEventId": { "title": "allowedEventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Id" }, "allowedEventCode": { "title": "allowedEventCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Code" }, "allowedEventDescription": { "title": "allowedEventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_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" } } }, "GetWorkOrderProgressEventAllowedChangeCollectionResourceActionResponse": { "title": "GetWorkOrderProgressEventAllowedChangeCollectionResourceActionResponse", "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": "GetWorkOrderProgressEventAllowedChangeCollectionResourceActionResponseItem", "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": "GetWorkOrderProgressEventAllowedChangeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->SequenceNumber" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Description" }, "allowedEventId": { "title": "allowedEventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Id" }, "allowedEventCode": { "title": "allowedEventCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Code" }, "allowedEventDescription": { "title": "allowedEventDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEventAllowedChange->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressEventAllowedChange->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" } } } }, "GetWorkOrderProgressEventAllowedChangeForWorkOrderProgressEventCollectionResourceActionResponse": { "title": "GetWorkOrderProgressEventAllowedChangeForWorkOrderProgressEventCollectionResourceActionResponse", "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": "GetWorkOrderProgressEventAllowedChangeForWorkOrderProgressEventCollectionResourceActionResponseItem", "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": "GetWorkOrderProgressEventAllowedChangeForWorkOrderProgressEventCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "allowedEventId": { "title": "allowedEventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Id" }, "allowedEventCode": { "title": "allowedEventCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Code" }, "allowedEventDescription": { "title": "allowedEventDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Notes" } } }, "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" } } } }, "WorkOrderProgressEventAllowedChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderProgressEventAllowedChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderProgressEventAllowedChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderProgressEventAllowedChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderProgressEventAllowedChangeInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderProgressEventAllowedChangeInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderProgressEventAllowedChangeInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderProgressEventAllowedChangeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEventLookupResourceActionResponse": { "title": "WorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEventLookupResourceActionResponse", "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": "WorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEventLookupResourceActionResponseItem", "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": "WorkOrderProgressEventAllowedChangeWorkOrderProgressAllowedEventLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->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" } } } }, "WorkOrderProgressEventAllowedChangeWorkOrderProgressEventLookupResourceActionResponse": { "title": "WorkOrderProgressEventAllowedChangeWorkOrderProgressEventLookupResourceActionResponse", "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": "WorkOrderProgressEventAllowedChangeWorkOrderProgressEventLookupResourceActionResponseItem", "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": "WorkOrderProgressEventAllowedChangeWorkOrderProgressEventLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEvent->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" } } } }, "CreateWorkOrderProgressEventAllowedChangeResourceActionRequest": { "title": "CreateWorkOrderProgressEventAllowedChangeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderProgressEventAllowedChangeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "eventId", "allowedEventId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->SequenceNumber" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Event_Id" }, "allowedEventId": { "title": "allowedEventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderProgressEventAllowedChangeResourceActionRequest": { "title": "UpdateWorkOrderProgressEventAllowedChangeResourceActionRequest", "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": "WorkOrderProgressEventAllowedChange->SequenceNumber" }, { "title": "allowedEventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderProgressEventAllowedChange->AllowedEvent_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressEventAllowedChange->Notes" } ] } } }, "DeleteWorkOrderProgressEventAllowedChangeResourceActionRequest": { "title": "DeleteWorkOrderProgressEventAllowedChangeResourceActionRequest", "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 } } }, "BatchGetWorkOrderProgressEventAllowedChangeResourceAction": { "title": "BatchGetWorkOrderProgressEventAllowedChangeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Progress Event Allowed Change entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Progress Event Allowed Change entities", "items": { "$ref": "#/definitions/GetWorkOrderProgressEventAllowedChangeResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderProgressEventAllowedChangeResourceActionRequest": { "title": "BatchCreateWorkOrderProgressEventAllowedChangeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, "BatchUpdateWorkOrderProgressEventAllowedChangeResourceActionRequest": { "title": "BatchUpdateWorkOrderProgressEventAllowedChangeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, "BatchDeleteWorkOrderProgressEventAllowedChangeResourceActionRequest": { "title": "BatchDeleteWorkOrderProgressEventAllowedChangeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderProgressEventAllowedChangeResourceActionRequest" } }, "ChangeWorkOrderProgressEventAllowedChangeIsActiveResourceActionRequest": { "title": "ChangeWorkOrderProgressEventAllowedChangeIsActiveResourceActionRequest", "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": "WorkOrderProgressEventAllowedChange->IsActive" } ] } } }, "ChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest", "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": "WorkOrderProgressEventAllowedChange->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderProgressEventAllowedEventIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderProgressEventAllowedEventIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderProgressEventAllowedChangeIsActiveResourceActionRequest" } }, "BatchChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderProgressEventAllowedChangePermissionTreeResourceActionRequest" } }, "GetWorkOrderProgressLogResourceActionResponse": { "title": "GetWorkOrderProgressLogResourceActionResponse", "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": "GetWorkOrderProgressLogResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressLog->CreatedOn" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkOrderProgressLog->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->GeographicUnitOfMeasurement_Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->PermissionTree_Description" }, "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressLog->ExecutedOn" }, "freeTextReason": { "title": "freeTextReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->FreeTextReason" }, "workOrderStatusChangeId": { "title": "workOrderStatusChangeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_Id" }, "workOrderStatusChangeRemark": { "title": "workOrderStatusChangeRemark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_Remark" }, "workOrderStatusChangeNewStatusId": { "title": "workOrderStatusChangeNewStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Id" }, "workOrderStatusChangeNewStatusCode": { "title": "workOrderStatusChangeNewStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code" }, "workOrderStatusChangeNewStatusDescription": { "title": "workOrderStatusChangeNewStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description" }, "workOrderStatusChangeWorkOrderId": { "title": "workOrderStatusChangeWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_WorkOrder_Id" }, "workOrderStatusChangeWorkOrderCode": { "title": "workOrderStatusChangeWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_WorkOrder_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->Notes" }, "preConfiguredReasonId": { "title": "preConfiguredReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->PreConfiguredReason_Id" }, "preConfiguredReasonCode": { "title": "preConfiguredReasonCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->PreConfiguredReason_Code" }, "preConfiguredReasonDescription": { "title": "preConfiguredReasonDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->PreConfiguredReason_Description" }, "progressEventId": { "title": "progressEventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Id" }, "progressEventCode": { "title": "progressEventCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Code" }, "progressEventDescription": { "title": "progressEventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->WorkOrder_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" } } }, "GetWorkOrderProgressLogCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderProgressLogCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderProgressLogCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderProgressLogCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "progressEventCode": { "title": "progressEventCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Code" }, "progressEventDescription": { "title": "progressEventDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Description" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->CreatedByUser_FullName" }, "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressLog->ExecutedOn" }, "freeTextReason": { "title": "freeTextReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->FreeTextReason" }, "workOrderStatusChangeNewStatusBaseStatus": { "title": "workOrderStatusChangeNewStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderStatusChangeNewStatusCode": { "title": "workOrderStatusChangeNewStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code" }, "workOrderStatusChangeNewStatusDescription": { "title": "workOrderStatusChangeNewStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkOrderProgressLog->GeographicLocation" } } }, "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" } } } }, "GetWorkOrderProgressLogCollectionResourceActionResponse": { "title": "GetWorkOrderProgressLogCollectionResourceActionResponse", "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": "GetWorkOrderProgressLogCollectionResourceActionResponseItem", "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": "GetWorkOrderProgressLogCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrder_Code" }, "progressEventCode": { "title": "progressEventCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Code" }, "progressEventDescription": { "title": "progressEventDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->ProgressEvent_Description" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->CreatedByUser_FullName" }, "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressLog->ExecutedOn" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderProgressLog->CreatedOn" }, "freeTextReason": { "title": "freeTextReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderProgressLog->FreeTextReason" }, "workOrderStatusChangeNewStatusBaseStatus": { "title": "workOrderStatusChangeNewStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderStatusChangeNewStatusCode": { "title": "workOrderStatusChangeNewStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Code" }, "workOrderStatusChangeNewStatusDescription": { "title": "workOrderStatusChangeNewStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderProgressLog->WorkOrderStatusChange_NewStatus_Description" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkOrderProgressLog->GeographicLocation" } } }, "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" } } } }, "BatchGetWorkOrderProgressLogResourceAction": { "title": "BatchGetWorkOrderProgressLogResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Progress Log entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Progress Log entities", "items": { "$ref": "#/definitions/GetWorkOrderProgressLogResourceActionResponse" } }, "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" } } }, "GetWorkOrderServiceLevelAgreementResourceActionResponse": { "title": "GetWorkOrderServiceLevelAgreementResourceActionResponse", "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": "GetWorkOrderServiceLevelAgreementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "assignedDate": { "title": "assignedDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreement->AssignedDate" }, "calculateFromAssignedDate": { "title": "calculateFromAssignedDate", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->CalculateFromAssignedDate" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->IsHistorical" }, "mainMeasurePercentage": { "title": "mainMeasurePercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->MainMeasurePercentage" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->Origin", "x-formatSpecifier": "SLAProcessOrigin" }, "serviceLevelAgreementId": { "title": "serviceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Id" }, "serviceLevelAgreementCode": { "title": "serviceLevelAgreementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code" }, "serviceLevelAgreementDescription": { "title": "serviceLevelAgreementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description" }, "serviceLevelAgreementTemplateServiceLevelAgreementId": { "title": "serviceLevelAgreementTemplateServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->WorkOrder_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" } } }, "GetWorkOrderServiceLevelAgreementCollectionResourceActionResponse": { "title": "GetWorkOrderServiceLevelAgreementCollectionResourceActionResponse", "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": "GetWorkOrderServiceLevelAgreementCollectionResourceActionResponseItem", "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": "GetWorkOrderServiceLevelAgreementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "serviceLevelAgreementTemplateServiceLevelAgreementId": { "title": "serviceLevelAgreementTemplateServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id" }, "serviceLevelAgreementCode": { "title": "serviceLevelAgreementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code" }, "serviceLevelAgreementDescription": { "title": "serviceLevelAgreementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreement->WorkOrder_Code" }, "assignedDate": { "title": "assignedDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreement->AssignedDate" }, "mainMeasurePercentage": { "title": "mainMeasurePercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->MainMeasurePercentage" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->IsHistorical" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->Origin", "x-formatSpecifier": "SLAProcessOrigin" }, "calculateFromAssignedDate": { "title": "calculateFromAssignedDate", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->CalculateFromAssignedDate" } } }, "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" } } } }, "GetWorkOrderServiceLevelAgreementForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderServiceLevelAgreementForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderServiceLevelAgreementForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderServiceLevelAgreementForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "serviceLevelAgreementId": { "title": "serviceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Id" }, "serviceLevelAgreementTemplateServiceLevelAgreementId": { "title": "serviceLevelAgreementTemplateServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_TemplateServiceLevelAgreement_Id" }, "serviceLevelAgreementCode": { "title": "serviceLevelAgreementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Code" }, "serviceLevelAgreementDescription": { "title": "serviceLevelAgreementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreement->ServiceLevelAgreement_Description" }, "assignedDate": { "title": "assignedDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreement->AssignedDate" }, "mainMeasurePercentage": { "title": "mainMeasurePercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->MainMeasurePercentage" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->IsHistorical" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->Origin", "x-formatSpecifier": "SLAProcessOrigin" }, "calculateFromAssignedDate": { "title": "calculateFromAssignedDate", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreement->CalculateFromAssignedDate" } } }, "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" } } } }, "BatchGetWorkOrderServiceLevelAgreementResourceAction": { "title": "BatchGetWorkOrderServiceLevelAgreementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Service Level Agreement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Service Level Agreement entities", "items": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementResourceActionResponse" } }, "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" } } }, "GetWorkOrderServiceLevelAgreementMeasureResourceActionResponse": { "title": "GetWorkOrderServiceLevelAgreementMeasureResourceActionResponse", "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": "GetWorkOrderServiceLevelAgreementMeasureResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "completeDate": { "title": "completeDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->CompleteDate" }, "durationUsed": { "title": "durationUsed", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->DurationUsed" }, "durationUsedPercentage": { "title": "durationUsedPercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage" }, "errorStatus": { "title": "errorStatus", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ErrorStatus" }, "expectedCompleteDate": { "title": "expectedCompleteDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate" }, "inStatusRange": { "title": "inStatusRange", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->InStatusRange" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->IsHistorical" }, "lastCalculatedOn": { "title": "lastCalculatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn" }, "measureResetDate": { "title": "measureResetDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->MeasureResetDate" }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description" }, "serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id" }, "startDate": { "title": "startDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->StartDate" }, "workOrderServiceLevelAgreementId": { "title": "workOrderServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_Id" }, "workOrderServiceLevelAgreementServiceLevelAgreementId": { "title": "workOrderServiceLevelAgreementServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Id" }, "workOrderServiceLevelAgreementServiceLevelAgreementCode": { "title": "workOrderServiceLevelAgreementServiceLevelAgreementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code" }, "workOrderServiceLevelAgreementServiceLevelAgreementDescription": { "title": "workOrderServiceLevelAgreementServiceLevelAgreementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_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" } } }, "GetWorkOrderServiceLevelAgreementMeasureCollectionResourceActionResponse": { "title": "GetWorkOrderServiceLevelAgreementMeasureCollectionResourceActionResponse", "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": "GetWorkOrderServiceLevelAgreementMeasureCollectionResourceActionResponseItem", "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": "GetWorkOrderServiceLevelAgreementMeasureCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderServiceLevelAgreementId": { "title": "workOrderServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_Id" }, "workOrderServiceLevelAgreementWorkOrderCode": { "title": "workOrderServiceLevelAgreementWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_WorkOrder_Code" }, "workOrderServiceLevelAgreementServiceLevelAgreementId": { "title": "workOrderServiceLevelAgreementServiceLevelAgreementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Id" }, "workOrderServiceLevelAgreementServiceLevelAgreementCode": { "title": "workOrderServiceLevelAgreementServiceLevelAgreementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code" }, "serviceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description" }, "serviceLevelAgreementMeasureDuration": { "title": "serviceLevelAgreementMeasureDuration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Duration" }, "serviceLevelAgreementMeasureWorkOrderStartStatusId": { "title": "serviceLevelAgreementMeasureWorkOrderStartStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderStartStatus_Id" }, "serviceLevelAgreementMeasureWorkOrderStartStatusCode": { "title": "serviceLevelAgreementMeasureWorkOrderStartStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderStartStatus_Code" }, "serviceLevelAgreementMeasureWorkOrderEndStatusId": { "title": "serviceLevelAgreementMeasureWorkOrderEndStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderEndStatus_Id" }, "serviceLevelAgreementMeasureWorkOrderEndStatusCode": { "title": "serviceLevelAgreementMeasureWorkOrderEndStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_WorkOrderEndStatus_Code" }, "inStatusRange": { "title": "inStatusRange", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->InStatusRange" }, "startDate": { "title": "startDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->StartDate" }, "completeDate": { "title": "completeDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->CompleteDate" }, "expectedCompleteDate": { "title": "expectedCompleteDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate" }, "durationUsed": { "title": "durationUsed", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->DurationUsed" }, "durationUsedPercentage": { "title": "durationUsedPercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage" }, "measureResetDate": { "title": "measureResetDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->MeasureResetDate" }, "lastCalculatedOn": { "title": "lastCalculatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn" } } }, "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" } } } }, "GetWorkOrderServiceLevelAgreementMeasureForWorkOrderServiceLevelAgreementCollectionResourceActionResponse": { "title": "GetWorkOrderServiceLevelAgreementMeasureForWorkOrderServiceLevelAgreementCollectionResourceActionResponse", "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": "GetWorkOrderServiceLevelAgreementMeasureForWorkOrderServiceLevelAgreementCollectionResourceActionResponseItem", "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": "GetWorkOrderServiceLevelAgreementMeasureForWorkOrderServiceLevelAgreementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId": { "title": "serviceLevelAgreementMeasureTemplateServiceLevelAgreementMeasureId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_TemplateServiceLevelAgreementMeasure_Id" }, "serviceLevelAgreementMeasureCode": { "title": "serviceLevelAgreementMeasureCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Code" }, "serviceLevelAgreementMeasureDescription": { "title": "serviceLevelAgreementMeasureDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ServiceLevelAgreementMeasure_Description" }, "workOrderServiceLevelAgreementServiceLevelAgreementCode": { "title": "workOrderServiceLevelAgreementServiceLevelAgreementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->WorkOrderServiceLevelAgreement_ServiceLevelAgreement_Code" }, "inStatusRange": { "title": "inStatusRange", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->InStatusRange" }, "startDate": { "title": "startDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->StartDate" }, "completeDate": { "title": "completeDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->CompleteDate" }, "expectedCompleteDate": { "title": "expectedCompleteDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->ExpectedCompleteDate" }, "durationUsed": { "title": "durationUsed", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->DurationUsed" }, "durationUsedPercentage": { "title": "durationUsedPercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->DurationUsedPercentage" }, "measureResetDate": { "title": "measureResetDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->MeasureResetDate" }, "lastCalculatedOn": { "title": "lastCalculatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderServiceLevelAgreementMeasure->LastCalculatedOn" } } }, "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" } } } }, "BatchGetWorkOrderServiceLevelAgreementMeasureResourceAction": { "title": "BatchGetWorkOrderServiceLevelAgreementMeasureResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Service Level Agreement Measure entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Service Level Agreement Measure entities", "items": { "$ref": "#/definitions/GetWorkOrderServiceLevelAgreementMeasureResourceActionResponse" } }, "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" } } }, "GetWorkOrderStatusResourceActionResponse": { "title": "GetWorkOrderStatusResourceActionResponse", "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": "GetWorkOrderStatusResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatus->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatus->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->PermissionTree_Description" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ApplyStatusRestrictions" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->SequenceNumber" }, "statusClassificationId": { "title": "statusClassificationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->StatusClassification_Id" }, "statusClassificationCode": { "title": "statusClassificationCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->StatusClassification_Code" }, "statusClassificationDescription": { "title": "statusClassificationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->StatusClassification_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" } } }, "GetWorkOrderStatusCollectionResourceActionResponse": { "title": "GetWorkOrderStatusCollectionResourceActionResponse", "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": "GetWorkOrderStatusCollectionResourceActionResponseItem", "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": "GetWorkOrderStatusCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ApplyStatusRestrictions" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->IsActive" } } }, "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" } } } }, "WorkOrderStatusChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusStatusClassificationLookupResourceActionResponse": { "title": "WorkOrderStatusStatusClassificationLookupResourceActionResponse", "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": "WorkOrderStatusStatusClassificationLookupResourceActionResponseItem", "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": "WorkOrderStatusStatusClassificationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "CreateWorkOrderStatusResourceActionRequest": { "title": "CreateWorkOrderStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "baseStatus" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ApplyStatusRestrictions" }, "statusClassificationId": { "title": "statusClassificationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->StatusClassification_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderStatusResourceActionRequest": { "title": "UpdateWorkOrderStatusResourceActionRequest", "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": "WorkOrderStatus->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->SequenceNumber" }, { "title": "statusClassificationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->StatusClassification_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->Notes" }, { "title": "applyStatusRestrictions", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ApplyStatusRestrictions" } ] } } }, "DeleteWorkOrderStatusResourceActionRequest": { "title": "DeleteWorkOrderStatusResourceActionRequest", "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 } } }, "BatchGetWorkOrderStatusResourceAction": { "title": "BatchGetWorkOrderStatusResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Status entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Status entities", "items": { "$ref": "#/definitions/GetWorkOrderStatusResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderStatusResourceActionRequest": { "title": "BatchCreateWorkOrderStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderStatusResourceActionRequest" } }, "BatchUpdateWorkOrderStatusResourceActionRequest": { "title": "BatchUpdateWorkOrderStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderStatusResourceActionRequest" } }, "BatchDeleteWorkOrderStatusResourceActionRequest": { "title": "BatchDeleteWorkOrderStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderStatusResourceActionRequest" } }, "ChangeWorkOrderStatusIsActiveResourceActionRequest": { "title": "ChangeWorkOrderStatusIsActiveResourceActionRequest", "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": "WorkOrderStatus->IsActive" } ] } } }, "ChangeWorkOrderStatusPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderStatusPermissionTreeResourceActionRequest", "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": "WorkOrderStatus->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderStatusIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderStatusIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusIsActiveResourceActionRequest" } }, "BatchChangeWorkOrderStatusPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderStatusPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusPermissionTreeResourceActionRequest" } }, "GetWorkOrderStatusAllowedChangeResourceActionResponse": { "title": "GetWorkOrderStatusAllowedChangeResourceActionResponse", "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": "GetWorkOrderStatusAllowedChangeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAllowedChange->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAllowedChange->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->Notes" }, "workOrderAllowedStatusId": { "title": "workOrderAllowedStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id" }, "workOrderAllowedStatusCode": { "title": "workOrderAllowedStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code" }, "workOrderAllowedStatusDescription": { "title": "workOrderAllowedStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_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" } } }, "GetWorkOrderStatusAllowedChangeCollectionResourceActionResponse": { "title": "GetWorkOrderStatusAllowedChangeCollectionResourceActionResponse", "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": "GetWorkOrderStatusAllowedChangeCollectionResourceActionResponseItem", "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": "GetWorkOrderStatusAllowedChangeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_Description" }, "workOrderAllowedStatusId": { "title": "workOrderAllowedStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id" }, "workOrderAllowedStatusCode": { "title": "workOrderAllowedStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code" }, "workOrderAllowedStatusDescription": { "title": "workOrderAllowedStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->IsActive" } } }, "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" } } } }, "GetWorkOrderStatusAllowedChangeForWorkOrderStatusCollectionResourceActionResponse": { "title": "GetWorkOrderStatusAllowedChangeForWorkOrderStatusCollectionResourceActionResponse", "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": "GetWorkOrderStatusAllowedChangeForWorkOrderStatusCollectionResourceActionResponseItem", "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": "GetWorkOrderStatusAllowedChangeForWorkOrderStatusCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderAllowedStatusId": { "title": "workOrderAllowedStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id" }, "workOrderAllowedStatusCode": { "title": "workOrderAllowedStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Code" }, "workOrderAllowedStatusDescription": { "title": "workOrderAllowedStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->Notes" } } }, "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" } } } }, "WorkOrderStatusAllowedChangeChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusAllowedChangeChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusAllowedChangeChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusAllowedChangeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusAllowedChangeInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusAllowedChangeInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusAllowedChangeInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusAllowedChangeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusAllowedChangeWorkOrderAllowedStatusLookupResourceActionResponse": { "title": "WorkOrderStatusAllowedChangeWorkOrderAllowedStatusLookupResourceActionResponse", "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": "WorkOrderStatusAllowedChangeWorkOrderAllowedStatusLookupResourceActionResponseItem", "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": "WorkOrderStatusAllowedChangeWorkOrderAllowedStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->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" } } } }, "WorkOrderStatusAllowedChangeWorkOrderStatusLookupResourceActionResponse": { "title": "WorkOrderStatusAllowedChangeWorkOrderStatusLookupResourceActionResponse", "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": "WorkOrderStatusAllowedChangeWorkOrderStatusLookupResourceActionResponseItem", "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": "WorkOrderStatusAllowedChangeWorkOrderStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->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" } } } }, "CreateWorkOrderStatusAllowedChangeResourceActionRequest": { "title": "CreateWorkOrderStatusAllowedChangeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderStatusAllowedChangeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderStatusId", "workOrderAllowedStatusId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->PermissionTree_Id", "x-systemGenerated": true }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderStatus_Id" }, "workOrderAllowedStatusId": { "title": "workOrderAllowedStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderStatusAllowedChangeResourceActionRequest": { "title": "UpdateWorkOrderStatusAllowedChangeResourceActionRequest", "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": "workOrderAllowedStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAllowedChange->WorkOrderAllowedStatus_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAllowedChange->Notes" } ] } } }, "DeleteWorkOrderStatusAllowedChangeResourceActionRequest": { "title": "DeleteWorkOrderStatusAllowedChangeResourceActionRequest", "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 } } }, "BatchGetWorkOrderStatusAllowedChangeResourceAction": { "title": "BatchGetWorkOrderStatusAllowedChangeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Status Allowed Change entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Status Allowed Change entities", "items": { "$ref": "#/definitions/GetWorkOrderStatusAllowedChangeResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderStatusAllowedChangeResourceActionRequest": { "title": "BatchCreateWorkOrderStatusAllowedChangeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderStatusAllowedChangeResourceActionRequest" } }, "BatchUpdateWorkOrderStatusAllowedChangeResourceActionRequest": { "title": "BatchUpdateWorkOrderStatusAllowedChangeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderStatusAllowedChangeResourceActionRequest" } }, "BatchDeleteWorkOrderStatusAllowedChangeResourceActionRequest": { "title": "BatchDeleteWorkOrderStatusAllowedChangeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderStatusAllowedChangeResourceActionRequest" } }, "ChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest": { "title": "ChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest", "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": "WorkOrderStatusAllowedChange->IsActive" } ] } } }, "ChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest", "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": "WorkOrderStatusAllowedChange->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusAllowedChangeIsActiveResourceActionRequest" } }, "BatchChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusAllowedChangePermissionTreeResourceActionRequest" } }, "GetWorkOrderStatusAttributeResourceActionResponse": { "title": "GetWorkOrderStatusAttributeResourceActionResponse", "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": "GetWorkOrderStatusAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->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" } } }, "GetWorkOrderStatusAttributeCollectionForWorkOrderStatusResourceActionResponse": { "title": "GetWorkOrderStatusAttributeCollectionForWorkOrderStatusResourceActionResponse", "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": "GetWorkOrderStatusAttributeCollectionForWorkOrderStatusResourceActionResponseItem", "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": "GetWorkOrderStatusAttributeCollectionForWorkOrderStatusResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAttribute->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" } } } }, "GetWorkOrderStatusAttributeCollectionResourceActionResponse": { "title": "GetWorkOrderStatusAttributeCollectionResourceActionResponse", "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": "GetWorkOrderStatusAttributeCollectionResourceActionResponseItem", "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": "GetWorkOrderStatusAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusAttribute->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" } } } }, "WorkOrderStatusAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "WorkOrderStatusAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "WorkOrderStatusAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "WorkOrderStatusAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusAttributeAttributeLookupResourceActionResponse": { "title": "WorkOrderStatusAttributeAttributeLookupResourceActionResponse", "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": "WorkOrderStatusAttributeAttributeLookupResourceActionResponseItem", "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": "WorkOrderStatusAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusAttributeChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusAttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusAttributeWorkOrderStatusLookupResourceActionResponse": { "title": "WorkOrderStatusAttributeWorkOrderStatusLookupResourceActionResponse", "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": "WorkOrderStatusAttributeWorkOrderStatusLookupResourceActionResponseItem", "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": "WorkOrderStatusAttributeWorkOrderStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->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" } } } }, "CreateWorkOrderStatusAttributeResourceActionRequest": { "title": "CreateWorkOrderStatusAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderStatusAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderStatusId", "attributeId" ], "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->WorkOrderStatus_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderStatusAttributeResourceActionRequest": { "title": "UpdateWorkOrderStatusAttributeResourceActionRequest", "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": "WorkOrderStatusAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusAttribute->Notes" } ] } } }, "DeleteWorkOrderStatusAttributeResourceActionRequest": { "title": "DeleteWorkOrderStatusAttributeResourceActionRequest", "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 } } }, "BatchGetWorkOrderStatusAttributeResourceAction": { "title": "BatchGetWorkOrderStatusAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Status Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Status Attribute entities", "items": { "$ref": "#/definitions/GetWorkOrderStatusAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderStatusAttributeResourceActionRequest": { "title": "BatchCreateWorkOrderStatusAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderStatusAttributeResourceActionRequest" } }, "BatchUpdateWorkOrderStatusAttributeResourceActionRequest": { "title": "BatchUpdateWorkOrderStatusAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderStatusAttributeResourceActionRequest" } }, "BatchDeleteWorkOrderStatusAttributeResourceActionRequest": { "title": "BatchDeleteWorkOrderStatusAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderStatusAttributeResourceActionRequest" } }, "ChangeWorkOrderStatusAttributeIsActiveResourceActionRequest": { "title": "ChangeWorkOrderStatusAttributeIsActiveResourceActionRequest", "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": "WorkOrderStatusAttribute->IsActive" } ] } } }, "ChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest", "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": "WorkOrderStatusAttribute->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusAttributePermissionTreeResourceActionRequest" } }, "BatchChangeWorkOrderStatusAttributeIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderStatusAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusAttributeIsActiveResourceActionRequest" } }, "GetWorkOrderStatusChangeHistoryResourceActionResponse": { "title": "GetWorkOrderStatusChangeHistoryResourceActionResponse", "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": "GetWorkOrderStatusChangeHistoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedOn" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Description" }, "offlineStatusChangedOn": { "title": "offlineStatusChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusChangeHistory->OfflineStatusChangedOn" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_Id" }, "predecessorWorkOrderId": { "title": "predecessorWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Id" }, "predecessorWorkOrderCode": { "title": "predecessorWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code" }, "predecessorWorkOrderDescription": { "title": "predecessorWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description" }, "predecessorWorkOrderWorkRequired": { "title": "predecessorWorkOrderWorkRequired", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_WorkRequired" }, "predecessorWorkOrderSiteId": { "title": "predecessorWorkOrderSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Site_Id" }, "predecessorWorkOrderSiteCode": { "title": "predecessorWorkOrderSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Site_Code" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Remark" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Description" }, "workOrderWorkRequired": { "title": "workOrderWorkRequired", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_WorkRequired" }, "workOrderSiteId": { "title": "workOrderSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Site_Id" }, "workOrderSiteCode": { "title": "workOrderSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Site_Code" } } }, "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" } } }, "GetWorkOrderStatusChangeHistoryCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderStatusChangeHistoryCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderStatusChangeHistoryCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderStatusChangeHistoryCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_Id" }, "predecessorWorkOrderCode": { "title": "predecessorWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code" }, "predecessorWorkOrderDescription": { "title": "predecessorWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Remark" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedByUser_Code" } } }, "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" } } } }, "GetWorkOrderStatusChangeHistoryCollectionResourceActionResponse": { "title": "GetWorkOrderStatusChangeHistoryCollectionResourceActionResponse", "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": "GetWorkOrderStatusChangeHistoryCollectionResourceActionResponseItem", "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": "GetWorkOrderStatusChangeHistoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_Id" }, "predecessorWorkOrderCode": { "title": "predecessorWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Code" }, "predecessorWorkOrderDescription": { "title": "predecessorWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->Predecessor_WorkOrder_Description" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->Remark" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->CreatedByUser_Code" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Description" }, "workOrderWorkRequired": { "title": "workOrderWorkRequired", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_WorkRequired" }, "workOrderPermissionTreeCode": { "title": "workOrderPermissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_PermissionTree_Code" }, "workOrderPermissionTreeDescription": { "title": "workOrderPermissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_PermissionTree_Description" }, "workOrderSiteCode": { "title": "workOrderSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_Site_Code" }, "workOrderSiteDescription": { "title": "workOrderSiteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusChangeHistory->WorkOrder_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" } } } }, "BatchGetWorkOrderStatusChangeHistoryResourceAction": { "title": "BatchGetWorkOrderStatusChangeHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Status Change History entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Status Change History entities", "items": { "$ref": "#/definitions/GetWorkOrderStatusChangeHistoryResourceActionResponse" } }, "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" } } }, "GetWorkOrderStatusDocumentResourceActionResponse": { "title": "GetWorkOrderStatusDocumentResourceActionResponse", "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": "GetWorkOrderStatusDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderStatusDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->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" } } }, "GetWorkOrderStatusDocumentCollectionForWorkOrderStatusResourceActionResponse": { "title": "GetWorkOrderStatusDocumentCollectionForWorkOrderStatusResourceActionResponse", "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": "GetWorkOrderStatusDocumentCollectionForWorkOrderStatusResourceActionResponseItem", "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": "GetWorkOrderStatusDocumentCollectionForWorkOrderStatusResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->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" } } } }, "GetWorkOrderStatusDocumentCollectionResourceActionResponse": { "title": "GetWorkOrderStatusDocumentCollectionResourceActionResponse", "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": "GetWorkOrderStatusDocumentCollectionResourceActionResponseItem", "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": "GetWorkOrderStatusDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->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" } } } }, "WorkOrderStatusDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusDocumentChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusDocumentDocumentLookupResourceActionResponse": { "title": "WorkOrderStatusDocumentDocumentLookupResourceActionResponse", "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": "WorkOrderStatusDocumentDocumentLookupResourceActionResponseItem", "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": "WorkOrderStatusDocumentDocumentLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "WorkOrderStatusDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderStatusDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderStatusDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderStatusDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderStatusDocumentWorkOrderStatusLookupResourceActionResponse": { "title": "WorkOrderStatusDocumentWorkOrderStatusLookupResourceActionResponse", "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": "WorkOrderStatusDocumentWorkOrderStatusLookupResourceActionResponseItem", "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": "WorkOrderStatusDocumentWorkOrderStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderStatus->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" } } } }, "CreateWorkOrderStatusDocumentResourceActionRequest": { "title": "CreateWorkOrderStatusDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderStatusDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderStatusId", "documentRecordId" ], "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->WorkOrderStatus_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderStatusDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderStatusDocumentResourceActionRequest": { "title": "UpdateWorkOrderStatusDocumentResourceActionRequest", "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": "WorkOrderStatusDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderStatusDocument->Notes" } ] } } }, "DeleteWorkOrderStatusDocumentResourceActionRequest": { "title": "DeleteWorkOrderStatusDocumentResourceActionRequest", "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 } } }, "BatchGetWorkOrderStatusDocumentResourceAction": { "title": "BatchGetWorkOrderStatusDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Status Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Status Document entities", "items": { "$ref": "#/definitions/GetWorkOrderStatusDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderStatusDocumentResourceActionRequest": { "title": "BatchCreateWorkOrderStatusDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderStatusDocumentResourceActionRequest" } }, "BatchUpdateWorkOrderStatusDocumentResourceActionRequest": { "title": "BatchUpdateWorkOrderStatusDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderStatusDocumentResourceActionRequest" } }, "BatchDeleteWorkOrderStatusDocumentResourceActionRequest": { "title": "BatchDeleteWorkOrderStatusDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderStatusDocumentResourceActionRequest" } }, "ChangeWorkOrderStatusDocumentIsActiveResourceActionRequest": { "title": "ChangeWorkOrderStatusDocumentIsActiveResourceActionRequest", "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": "WorkOrderStatusDocument->IsActive" } ] } } }, "ChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest", "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": "WorkOrderStatusDocument->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeWorkOrderStatusDocumentIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderStatusDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderStatusDocumentIsActiveResourceActionRequest" } }, "GetWorkOrderTaskResourceActionResponse": { "title": "GetWorkOrderTaskResourceActionResponse", "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": "GetWorkOrderTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PermissionTree_Description" }, "actualInterval1": { "title": "actualInterval1", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ActualInterval1" }, "actualInterval2": { "title": "actualInterval2", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ActualInterval2" }, "appliedInterval": { "title": "appliedInterval", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AppliedInterval", "x-formatSpecifier": "WorkOrderTaskAppliedInterval" }, "assetTaskAssetId": { "title": "assetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Id" }, "assetTaskAssetCode": { "title": "assetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Code" }, "assetTaskAssetDescription": { "title": "assetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Description" }, "assetTaskClassification1Id": { "title": "assetTaskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification1_Id" }, "assetTaskClassification1Code": { "title": "assetTaskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification1_Code" }, "assetTaskClassification1Description": { "title": "assetTaskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification1_Description" }, "assetTaskClassification2Id": { "title": "assetTaskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification2_Id" }, "assetTaskClassification2Code": { "title": "assetTaskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification2_Code" }, "assetTaskClassification2Description": { "title": "assetTaskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification2_Description" }, "assetTaskClassification3Id": { "title": "assetTaskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification3_Id" }, "assetTaskClassification3Code": { "title": "assetTaskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification3_Code" }, "assetTaskClassification3Description": { "title": "assetTaskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification3_Description" }, "assetTaskClassification4Id": { "title": "assetTaskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification4_Id" }, "assetTaskClassification4Code": { "title": "assetTaskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification4_Code" }, "assetTaskClassification4Description": { "title": "assetTaskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification4_Description" }, "assetTaskClassification5Id": { "title": "assetTaskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification5_Id" }, "assetTaskClassification5Code": { "title": "assetTaskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification5_Code" }, "assetTaskClassification5Description": { "title": "assetTaskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification5_Description" }, "assetTaskClassification6Id": { "title": "assetTaskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification6_Id" }, "assetTaskClassification6Code": { "title": "assetTaskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification6_Code" }, "assetTaskClassification6Description": { "title": "assetTaskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification6_Description" }, "assetTaskClassification7Id": { "title": "assetTaskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification7_Id" }, "assetTaskClassification7Code": { "title": "assetTaskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification7_Code" }, "assetTaskClassification7Description": { "title": "assetTaskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification7_Description" }, "assetTaskClassification8Id": { "title": "assetTaskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification8_Id" }, "assetTaskClassification8Code": { "title": "assetTaskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskClassification8_Code" }, "assetTaskComponentId": { "title": "assetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Id" }, "assetTaskComponentCode": { "title": "assetTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Code" }, "assetTaskComponentDescription": { "title": "assetTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Description" }, "assetTreePathId": { "title": "assetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTreePathId" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTask->AssetTreePathItems", "x-formatSpecifier": "TreePathItem" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CompletedOn" }, "componentTreePathId": { "title": "componentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ComponentTreePathId" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTask->ComponentTreePathItems", "x-formatSpecifier": "TreePathItem" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval1_Id" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval2_Id" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval2_Description" }, "disabledReasons": { "title": "disabledReasons", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "WorkOrderTaskDisabledReason" }, "x-propertyPath": "WorkOrderTask->DisabledReasons", "x-formatSpecifier": "WorkOrderTaskDisabledReason" }, "displaySequenceNumber": { "title": "displaySequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DisplaySequenceNumber" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DueReading" }, "failedReason": { "title": "failedReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FailedReason" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FailedReasonRequired" }, "fmecaFailedReasonId": { "title": "fmecaFailedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FmecaFailedReason_Id" }, "fmecaFailedReasonAssetId": { "title": "fmecaFailedReasonAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FmecaFailedReason_Asset_Id" }, "fmecaFailedReasonAssetCode": { "title": "fmecaFailedReasonAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FmecaFailedReason_Asset_Code" }, "fmecaFailedReasonAssetDescription": { "title": "fmecaFailedReasonAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FmecaFailedReason_Asset_Description" }, "hasNonUsageBasedMeter": { "title": "hasNonUsageBasedMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->HasNonUsageBasedMeter" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTask->InspectionType", "x-formatSpecifier": "InspectionType" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType2_Description" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsEnabled" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsMandatory" }, "lastScheduledServiceDate": { "title": "lastScheduledServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderTask->LastScheduledServiceDate" }, "lastScheduledServiceMeterReading": { "title": "lastScheduledServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->LastScheduledServiceMeterReading" }, "lastServiceDate": { "title": "lastServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderTask->LastServiceDate" }, "lastServiceMeterReading": { "title": "lastServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->LastServiceMeterReading" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Meter_Description" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->MeterReadingOn" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->MeterReadingValue", "x-NullExpression": "WorkOrderTask->Meter_Id eq NULL" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->MotionType", "x-formatSpecifier": "MotionType" }, "notCompletedReasonId": { "title": "notCompletedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Id", "x-NullExpression": "WorkOrderTask->Completed eq true" }, "notCompletedReasonCode": { "title": "notCompletedReasonCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Code" }, "notCompletedReasonDescription": { "title": "notCompletedReasonDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Notes" }, "passed": { "title": "passed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Passed", "x-NullExpression": "WorkOrderTask->IsInspection eq TRUE" }, "predefinedFailedReasonId": { "title": "predefinedFailedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PredefinedFailedReason_Id" }, "predefinedFailedReasonCode": { "title": "predefinedFailedReasonCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PredefinedFailedReason_Code" }, "predefinedFailedReasonDescription": { "title": "predefinedFailedReasonDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PredefinedFailedReason_Description" }, "priority": { "title": "priority", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Priority" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->SequenceNumber" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->StaffMember_Id" }, "staffMemberCode": { "title": "staffMemberCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->StaffMember_Code" }, "staffMemberResourceType": { "title": "staffMemberResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTask->StaffMember_ResourceType", "x-formatSpecifier": "ResourceType" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->StartedOn" }, "taskAlternativeDescription": { "title": "taskAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskAlternativeDescription" }, "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "taskFeedbackClassification1Id": { "title": "taskFeedbackClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Id" }, "taskFeedbackClassification1Code": { "title": "taskFeedbackClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Code" }, "taskFeedbackClassification1Description": { "title": "taskFeedbackClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Description" }, "taskFeedbackClassification2Id": { "title": "taskFeedbackClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Id" }, "taskFeedbackClassification2Code": { "title": "taskFeedbackClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Code" }, "taskFeedbackClassification2Description": { "title": "taskFeedbackClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Description" }, "taskFeedbackClassification3Id": { "title": "taskFeedbackClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Id" }, "taskFeedbackClassification3Code": { "title": "taskFeedbackClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Code" }, "taskFeedbackClassification3Description": { "title": "taskFeedbackClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Description" }, "taskFeedbackClassification4Id": { "title": "taskFeedbackClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Id" }, "taskFeedbackClassification4Code": { "title": "taskFeedbackClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Code" }, "taskFeedbackClassification4Description": { "title": "taskFeedbackClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Description" }, "taskFeedbackClassification5Id": { "title": "taskFeedbackClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Id" }, "taskFeedbackClassification5Code": { "title": "taskFeedbackClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Code" }, "taskFeedbackClassification5Description": { "title": "taskFeedbackClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Description" }, "taskId": { "title": "taskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskId" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkOrderTask->TotalDuration" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Trade_Description" }, "triggerWhenLowerCriticalBoundExceeded": { "title": "triggerWhenLowerCriticalBoundExceeded", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TriggerWhenLowerCriticalBoundExceeded" }, "triggerWhenLowerWarningBoundExceeded": { "title": "triggerWhenLowerWarningBoundExceeded", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TriggerWhenLowerWarningBoundExceeded" }, "triggerWhenUpperCriticalBoundExceeded": { "title": "triggerWhenUpperCriticalBoundExceeded", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TriggerWhenUpperCriticalBoundExceeded" }, "triggerWhenUpperWarningBoundExceeded": { "title": "triggerWhenUpperWarningBoundExceeded", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TriggerWhenUpperWarningBoundExceeded" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Description" }, "workOrderRequiredBy": { "title": "workOrderRequiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->WorkOrder_RequiredBy" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Status_Id" }, "workOrderStatusBaseStatus": { "title": "workOrderStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderInspectionTaskId": { "title": "workOrderInspectionTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_Id" }, "workOrderInspectionTaskTaskCode": { "title": "workOrderInspectionTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_TaskCode" }, "workOrderInspectionTaskTaskDescription": { "title": "workOrderInspectionTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_TaskDescription" }, "workOrderInspectionTaskWorkOrderId": { "title": "workOrderInspectionTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Id" }, "workOrderInspectionTaskWorkOrderCode": { "title": "workOrderInspectionTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_WorkOrder_Code" }, "workOrderInspectionTaskWorkOrderDescription": { "title": "workOrderInspectionTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_WorkOrder_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" } } }, "GetRequisitionItemForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetRequisitionItemForWorkOrderTaskCollectionResourceActionResponse", "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": "GetRequisitionItemForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetRequisitionItemForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionCode": { "title": "requisitionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareWorkOrderTaskWorkOrderCode": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code" }, "workOrderTaskSpareWorkOrderTaskTaskCode": { "title": "workOrderTaskSpareWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode" }, "workOrderTaskSpareWorkOrderTaskTaskDescription": { "title": "workOrderTaskSpareWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareStockItemMaterialMasterId": { "title": "workOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemMaterialMasterDescription": { "title": "workOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "workOrderTaskSpareStockItemWarehouseDescription": { "title": "workOrderTaskSpareStockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description" }, "workOrderTaskSpareStockItemAverageItemCost": { "title": "workOrderTaskSpareStockItemAverageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost" }, "workOrderTaskSpareStockItemQuantityOnHand": { "title": "workOrderTaskSpareStockItemQuantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand" }, "workOrderTaskSpareSupplierCode": { "title": "workOrderTaskSpareSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Code" }, "workOrderTaskSpareSupplierDescription": { "title": "workOrderTaskSpareSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Description" }, "workOrderTaskSpareUnitPriceInSpareCurrency": { "title": "workOrderTaskSpareUnitPriceInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency" }, "workOrderTaskSpareUnitPriceInWorkOrderCurrency": { "title": "workOrderTaskSpareUnitPriceInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInWorkOrderCurrency" }, "workOrderTaskSpareTotalUsedInWorkOrderCurrency": { "title": "workOrderTaskSpareTotalUsedInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency" }, "quantityIssued": { "title": "quantityIssued", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityIssued" }, "quantityNotIssued": { "title": "quantityNotIssued", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityNotIssued" } } }, "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" } } } }, "GetWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Description" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Status_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Status_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Status_Description" }, "assetTaskAssetId": { "title": "assetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Id" }, "assetTaskAssetCode": { "title": "assetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Code" }, "assetTaskAssetDescription": { "title": "assetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Description" }, "assetTaskComponentId": { "title": "assetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Id" }, "assetTaskComponentCode": { "title": "assetTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Code" }, "assetTaskComponentDescription": { "title": "assetTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->SequenceNumber" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" }, "taskId": { "title": "taskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskId" }, "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "taskAlternativeDescription": { "title": "taskAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskAlternativeDescription" }, "hasNonUsageBasedMeter": { "title": "hasNonUsageBasedMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->HasNonUsageBasedMeter" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DueReading" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IntervalType2_Description" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval1_Id" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval2_Id" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DefaultInterval2_Description" }, "actualInterval1": { "title": "actualInterval1", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ActualInterval1" }, "actualInterval2": { "title": "actualInterval2", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->ActualInterval2" }, "appliedInterval": { "title": "appliedInterval", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AppliedInterval", "x-formatSpecifier": "WorkOrderTaskAppliedInterval" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsMandatory" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsInspection" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsEnabled" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Meter_Code" }, "passed": { "title": "passed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Passed", "x-NullExpression": "WorkOrderTask->IsInspection eq TRUE" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->StartedOn" }, "taskFeedbackClassification1Id": { "title": "taskFeedbackClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Id" }, "taskFeedbackClassification1Code": { "title": "taskFeedbackClassification1Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Code" }, "taskFeedbackClassification1Description": { "title": "taskFeedbackClassification1Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Description" }, "taskFeedbackClassification2Id": { "title": "taskFeedbackClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Id" }, "taskFeedbackClassification2Code": { "title": "taskFeedbackClassification2Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Code" }, "taskFeedbackClassification2Description": { "title": "taskFeedbackClassification2Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Description" }, "taskFeedbackClassification3Id": { "title": "taskFeedbackClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Id" }, "taskFeedbackClassification3Code": { "title": "taskFeedbackClassification3Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Code" }, "taskFeedbackClassification3Description": { "title": "taskFeedbackClassification3Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Description" }, "taskFeedbackClassification4Id": { "title": "taskFeedbackClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Id" }, "taskFeedbackClassification4Code": { "title": "taskFeedbackClassification4Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Code" }, "taskFeedbackClassification4Description": { "title": "taskFeedbackClassification4Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Description" }, "taskFeedbackClassification5Id": { "title": "taskFeedbackClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Id" }, "taskFeedbackClassification5Code": { "title": "taskFeedbackClassification5Code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Code" }, "taskFeedbackClassification5Description": { "title": "taskFeedbackClassification5Description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Description" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CompletedOn" }, "notCompletedReasonId": { "title": "notCompletedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Id" }, "notCompletedReasonCode": { "title": "notCompletedReasonCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Code" }, "notCompletedReasonDescription": { "title": "notCompletedReasonDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Notes" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->MeterReadingValue", "x-NullExpression": "WorkOrderTask->Meter_Id eq NULL" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->ModifiedOn" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CreatedOn" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTask->AssetTreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTask->ComponentTreePathItems", "x-formatSpecifier": "TreePathItem" }, "workOrderInspectionTaskId": { "title": "workOrderInspectionTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrderInspectionTask_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" } } } }, "GetWorkOrderTaskForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderTaskForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderTaskForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "taskId": { "title": "taskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskId" }, "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "assetTaskAssetId": { "title": "assetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Id" }, "assetTaskAssetCode": { "title": "assetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Code" }, "assetTaskAssetDescription": { "title": "assetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskAsset_Description" }, "taskAlternativeDescription": { "title": "taskAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskAlternativeDescription" }, "assetTaskComponentId": { "title": "assetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Id" }, "assetTaskComponentCode": { "title": "assetTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Code" }, "assetTaskComponentDescription": { "title": "assetTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->AssetTaskComponent_Description" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Meter_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->SequenceNumber" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsMandatory" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsInspection" }, "passed": { "title": "passed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Passed", "x-NullExpression": "WorkOrderTask->IsInspection eq TRUE" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CompletedOn" }, "notCompletedReasonId": { "title": "notCompletedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Id" }, "notCompletedReasonCode": { "title": "notCompletedReasonCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Code" }, "notCompletedReasonDescription": { "title": "notCompletedReasonDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Description" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->MeterReadingValue", "x-NullExpression": "WorkOrderTask->Meter_Id eq NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->MeterReadingOn" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->IsEnabled" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTask->AssetTreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTask->ComponentTreePathItems", "x-formatSpecifier": "TreePathItem" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->StartedOn" }, "displaySequenceNumber": { "title": "displaySequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->DisplaySequenceNumber" } } }, "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" } } } }, "GetWorkOrderTaskFollowUpTaskSpareCollectionResourceActionResponse": { "title": "GetWorkOrderTaskFollowUpTaskSpareCollectionResourceActionResponse", "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": "GetWorkOrderTaskFollowUpTaskSpareCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskFollowUpTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Description" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Code" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->Quantity" } } }, "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" } } } }, "WorkOrderTaskAssetTaskForAssetLookupResourceActionResponse": { "title": "WorkOrderTaskAssetTaskForAssetLookupResourceActionResponse", "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": "WorkOrderTaskAssetTaskForAssetLookupResourceActionResponseItem", "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": "WorkOrderTaskAssetTaskForAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetSiteCode": { "title": "assetSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Asset_Site_Code" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Description" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Id" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Id" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Description" }, "estimatedNextDueDate": { "title": "estimatedNextDueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->EstimatedNextDueDate" }, "estimatedNextDueMeterReading": { "title": "estimatedNextDueMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->EstimatedNextDueMeterReading" }, "actualInterval1": { "title": "actualInterval1", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ActualInterval1" }, "actualInterval2": { "title": "actualInterval2", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ActualInterval2" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTask->InspectionType eq 'PassOrFail'" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Meter_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MotionType", "x-formatSpecifier": "MotionType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Description" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceDescription": { "title": "responsibleStaffMemberResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_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" } } } }, "WorkOrderTaskAssetTaskForSiteLookupResourceActionResponse": { "title": "WorkOrderTaskAssetTaskForSiteLookupResourceActionResponse", "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": "WorkOrderTaskAssetTaskForSiteLookupResourceActionResponseItem", "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": "WorkOrderTaskAssetTaskForSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetSiteCode": { "title": "assetSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Asset_Site_Code" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Description" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Id" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Id" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Description" }, "estimatedNextDueDate": { "title": "estimatedNextDueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->EstimatedNextDueDate" }, "estimatedNextDueMeterReading": { "title": "estimatedNextDueMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->EstimatedNextDueMeterReading" }, "actualInterval1": { "title": "actualInterval1", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ActualInterval1" }, "actualInterval2": { "title": "actualInterval2", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ActualInterval2" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTask->InspectionType eq 'PassOrFail'" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Meter_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MotionType", "x-formatSpecifier": "MotionType" } } }, "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" } } } }, "WorkOrderTaskChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskFinancialYearPeriodLookupResourceActionResponse": { "title": "WorkOrderTaskFinancialYearPeriodLookupResourceActionResponse", "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": "WorkOrderTaskFinancialYearPeriodLookupResourceActionResponseItem", "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": "WorkOrderTaskFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_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" } } } }, "WorkOrderTaskFmecaFailedReasonLookupResourceActionResponse": { "title": "WorkOrderTaskFmecaFailedReasonLookupResourceActionResponse", "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": "WorkOrderTaskFmecaFailedReasonLookupResourceActionResponseItem", "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": "WorkOrderTaskFmecaFailedReasonLookupResourceActionResponseItemProperties", "type": "object", "properties": { "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Description" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_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" } } } }, "WorkOrderTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskNotCompletedReasonLookupResourceActionResponse": { "title": "WorkOrderTaskNotCompletedReasonLookupResourceActionResponse", "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": "WorkOrderTaskNotCompletedReasonLookupResourceActionResponseItem", "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": "WorkOrderTaskNotCompletedReasonLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->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" } } } }, "WorkOrderTaskPredefinedFailedReasonLookupResourceActionResponse": { "title": "WorkOrderTaskPredefinedFailedReasonLookupResourceActionResponse", "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": "WorkOrderTaskPredefinedFailedReasonLookupResourceActionResponseItem", "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": "WorkOrderTaskPredefinedFailedReasonLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->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" } } } }, "WorkOrderTaskRequesterContactLookupResourceActionResponse": { "title": "WorkOrderTaskRequesterContactLookupResourceActionResponse", "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": "WorkOrderTaskRequesterContactLookupResourceActionResponseItem", "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": "WorkOrderTaskRequesterContactLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "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" } } } }, "WorkOrderTaskSectionLookupResourceActionResponse": { "title": "WorkOrderTaskSectionLookupResourceActionResponse", "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": "WorkOrderTaskSectionLookupResourceActionResponseItem", "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": "WorkOrderTaskSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "WorkOrderTaskStaffMemberLookupResourceActionResponse": { "title": "WorkOrderTaskStaffMemberLookupResourceActionResponse", "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": "WorkOrderTaskStaffMemberLookupResourceActionResponseItem", "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": "WorkOrderTaskStaffMemberLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "WorkOrderTaskStandardTaskLookupResourceActionResponse": { "title": "WorkOrderTaskStandardTaskLookupResourceActionResponse", "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": "WorkOrderTaskStandardTaskLookupResourceActionResponseItem", "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": "WorkOrderTaskStandardTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->AlternativeDescription" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Description" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval1_Id" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval2_Id" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval2_Description" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->FailedReasonRequired", "x-NullExpression": "StandardTask->InspectionType eq 'PassOrFail'" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsMandatory" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsInspection" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->MotionType", "x-formatSpecifier": "MotionType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->ResponsibleSection_Description" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->ResponsibleTrade_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceDescription": { "title": "responsibleStaffMemberResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_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" } } } }, "WorkOrderTaskTaskFeedbackClassification1LookupResourceActionResponse": { "title": "WorkOrderTaskTaskFeedbackClassification1LookupResourceActionResponse", "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": "WorkOrderTaskTaskFeedbackClassification1LookupResourceActionResponseItem", "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": "WorkOrderTaskTaskFeedbackClassification1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskTaskFeedbackClassification2LookupResourceActionResponse": { "title": "WorkOrderTaskTaskFeedbackClassification2LookupResourceActionResponse", "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": "WorkOrderTaskTaskFeedbackClassification2LookupResourceActionResponseItem", "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": "WorkOrderTaskTaskFeedbackClassification2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskTaskFeedbackClassification3LookupResourceActionResponse": { "title": "WorkOrderTaskTaskFeedbackClassification3LookupResourceActionResponse", "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": "WorkOrderTaskTaskFeedbackClassification3LookupResourceActionResponseItem", "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": "WorkOrderTaskTaskFeedbackClassification3LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskTaskFeedbackClassification4LookupResourceActionResponse": { "title": "WorkOrderTaskTaskFeedbackClassification4LookupResourceActionResponse", "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": "WorkOrderTaskTaskFeedbackClassification4LookupResourceActionResponseItem", "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": "WorkOrderTaskTaskFeedbackClassification4LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskTaskFeedbackClassification5LookupResourceActionResponse": { "title": "WorkOrderTaskTaskFeedbackClassification5LookupResourceActionResponse", "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": "WorkOrderTaskTaskFeedbackClassification5LookupResourceActionResponseItem", "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": "WorkOrderTaskTaskFeedbackClassification5LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "WorkOrderTaskTradeLookupResourceActionResponse": { "title": "WorkOrderTaskTradeLookupResourceActionResponse", "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": "WorkOrderTaskTradeLookupResourceActionResponseItem", "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": "WorkOrderTaskTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->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" } } } }, "WorkOrderTaskWorkOrderLookupResourceActionResponse": { "title": "WorkOrderTaskWorkOrderLookupResourceActionResponse", "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": "WorkOrderTaskWorkOrderLookupResourceActionResponseItem", "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": "WorkOrderTaskWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "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" } } } }, "CreateWorkOrderTaskResourceActionRequest": { "title": "CreateWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "taskId", "taskType", "workOrderId" ], "properties": { "taskId": { "title": "taskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskId" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CompletedOn" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->MeterReadingValue", "x-NullExpression": "WorkOrderTask->Meter_Id eq NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->MeterReadingOn" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->StaffMember_Id" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Trade_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Notes" }, "notCompletedReasonId": { "title": "notCompletedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Id", "x-NullExpression": "WorkOrderTask->Completed eq true" }, "passed": { "title": "passed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Passed", "x-NullExpression": "WorkOrderTask->IsInspection eq TRUE" }, "predefinedFailedReasonId": { "title": "predefinedFailedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PredefinedFailedReason_Id" }, "fmecaFailedReasonId": { "title": "fmecaFailedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FmecaFailedReason_Id" }, "failedReason": { "title": "failedReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FailedReason" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->SequenceNumber" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->StartedOn" }, "taskFeedbackClassification1Id": { "title": "taskFeedbackClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Id" }, "taskFeedbackClassification2Id": { "title": "taskFeedbackClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Id" }, "taskFeedbackClassification3Id": { "title": "taskFeedbackClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Id" }, "taskFeedbackClassification4Id": { "title": "taskFeedbackClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Id" }, "taskFeedbackClassification5Id": { "title": "taskFeedbackClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Id" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderTaskResourceActionRequest": { "title": "UpdateWorkOrderTaskResourceActionRequest", "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": "completed", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTask->Completed" }, { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->CompletedOn" }, { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTask->MeterReadingValue", "x-NullExpression": "WorkOrderTask->Meter_Id eq NULL" }, { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->MeterReadingOn" }, { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->StaffMember_Id" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Trade_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->Notes" }, { "title": "notCompletedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->NotCompletedReason_Id", "x-NullExpression": "WorkOrderTask->Completed eq true" }, { "title": "passed", "type": "boolean", "readOnly": true, "x-nullable": false, "x-propertyPath": "WorkOrderTask->Passed", "x-NullExpression": "WorkOrderTask->IsInspection eq TRUE", "x-ReadOnlyExpression": "WorkOrderTask->InspectionType eq 'ManualMonitoring' AND WorkOrderTask->Completed eq true" }, { "title": "predefinedFailedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->PredefinedFailedReason_Id" }, { "title": "fmecaFailedReasonId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FmecaFailedReason_Id" }, { "title": "failedReason", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->FailedReason" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTask->SequenceNumber" }, { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->StartedOn" }, { "title": "taskFeedbackClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification1_Id" }, { "title": "taskFeedbackClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification2_Id" }, { "title": "taskFeedbackClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification3_Id" }, { "title": "taskFeedbackClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification4_Id" }, { "title": "taskFeedbackClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskFeedbackClassification5_Id" } ] } } }, "DeleteWorkOrderTaskResourceActionRequest": { "title": "DeleteWorkOrderTaskResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskResourceAction": { "title": "BatchGetWorkOrderTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskResourceActionRequest": { "title": "BatchCreateWorkOrderTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderTaskResourceActionRequest" } }, "BatchUpdateWorkOrderTaskResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskResourceActionRequest" } }, "BatchDeleteWorkOrderTaskResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskResourceActionRequest" } }, "AddSpareToNewRequisitionForWorkTaskResourceActionRequest": { "title": "AddSpareToNewRequisitionForWorkTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AddSpareToNewRequisitionForWorkTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requesterType" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Code", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->PermissionTree_Id", "x-systemGenerated": true }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AddSpareToNewRequisition->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Requester" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->RequesterContact_Id" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddSpareToNewRequisition->RequestedOn", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "AddSpareToRequisitionForWorkOrderTaskResourceActionRequest": { "title": "AddSpareToRequisitionForWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AddSpareToRequisitionForWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requisitionId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AddSpareToRequisition->Requisition_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAddSpareToNewRequisitionForWorkOrderTaskResourceActionRequest": { "title": "BatchAddSpareToNewRequisitionForWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchAddSpareToNewRequisitionForWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds", "requesterType", "requestedOn" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "AddSpareToNewRequisition->EntityIds", "x-formatSpecifier": "Int64" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Code", "x-systemGenerated": true }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AddSpareToNewRequisition->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Requester" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->RequesterContact_Id" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddSpareToNewRequisition->RequestedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAddSpareToRequisitionForWorkOrderTaskResourceActionRequest": { "title": "BatchAddSpareToRequisitionForWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchAddSpareToRequisitionForWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "AddSpareToRequisition->EntityIds", "x-formatSpecifier": "Int64" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToRequisition->Requisition_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchIssueAllWorkOrderTaskResourceActionRequest": { "title": "BatchIssueAllWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchIssueAllWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchReturnAllWorkOrderTaskResourceActionRequest": { "title": "BatchReturnAllWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchReturnAllWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeWorkOrderTaskPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskPermissionTreeResourceActionRequest", "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": "WorkOrderTask->PermissionTree_Id" } ] } } }, "IssueAllWorkOrderTaskResourceActionRequest": { "title": "IssueAllWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "IssueAllWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ReturnAllWorkOrderTaskResourceActionRequest": { "title": "ReturnAllWorkOrderTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ReturnAllWorkOrderTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ValidateWorkOrderTaskMeterAdrResourceActionRequest": { "title": "ValidateWorkOrderTaskMeterAdrResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ValidateWorkOrderTaskMeterAdrResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderId" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ValidateWMMeterAdrEntity->WorkOrder_Id" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ValidateWMMeterAdrEntity->Meter_Id" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ValidateWMMeterAdrEntity->ReadingValue" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ValidateWMMeterAdrEntity->ReadingOn" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeWorkOrderTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskPermissionTreeResourceActionRequest" } }, "GetWorkOrderTaskAdHocCostResourceActionResponse": { "title": "GetWorkOrderTaskAdHocCostResourceActionResponse", "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": "GetWorkOrderTaskAdHocCostResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Id" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Description" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Id" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Code" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Description" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CurrencyRate_AppliedConversionRate" }, "currencyRateValue": { "title": "currencyRateValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CurrencyRateValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->FinancialYearPeriod_Id" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->FinancialYearPeriod_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->FinancialYearPeriod_Code" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Id" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Code" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Quantity" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Id" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Description" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Code" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->TotalCost" }, "totalCostInWorkOrderCurrency": { "title": "totalCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->TotalCostInWorkOrderCurrency" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->TransactedOn" }, "unitCost": { "title": "unitCost", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitCost" }, "unitCostInWorkOrderCurrency": { "title": "unitCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitCostInWorkOrderCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Id" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Description" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Code" }, "workOrderCurrencyId": { "title": "workOrderCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderCurrency_Id" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderCurrency_Code" }, "workOrderCurrencyDescription": { "title": "workOrderCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderCurrency_Description" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_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" } } }, "GetCostingCollectionForWorkOrderTaskAdHocCostResourceActionResponse": { "title": "GetCostingCollectionForWorkOrderTaskAdHocCostResourceActionResponse", "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": "GetCostingCollectionForWorkOrderTaskAdHocCostResourceActionResponseItem", "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": "GetCostingCollectionForWorkOrderTaskAdHocCostResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Description" }, "baseCurrencyId": { "title": "baseCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->BaseCurrency_Id" }, "baseCurrencyCode": { "title": "baseCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->BaseCurrency_Code" }, "conversionRateValue": { "title": "conversionRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->ConversionRateValue" }, "unitPriceInSiteCurrency": { "title": "unitPriceInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->UnitPriceInSiteCurrency" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Costing->TransactedOn" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->FinancialYearPeriod_Code" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrder_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "workOrderAssetId": { "title": "workOrderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Id" }, "workOrderAssetCode": { "title": "workOrderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Code" }, "workOrderAssetDescription": { "title": "workOrderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_Description" }, "workOrderAssetRecordType": { "title": "workOrderAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "workOrderTaskAssetId": { "title": "workOrderTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Id" }, "workOrderTaskAssetCode": { "title": "workOrderTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Code" }, "workOrderTaskAssetDescription": { "title": "workOrderTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_Description" }, "workOrderTaskAssetRecordType": { "title": "workOrderTaskAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "workOrderTaskAdHocCostId": { "title": "workOrderTaskAdHocCostId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Id" }, "workOrderTaskAdHocCostCode": { "title": "workOrderTaskAdHocCostCode", "type": "string", "x-nullable": true, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_Code" }, "workOrderTaskAdHocCostDescription": { "title": "workOrderTaskAdHocCostDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrderTaskAdHocCost_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" } } } }, "GetWorkOrderTaskAdHocCostCollectionResourceActionResponse": { "title": "GetWorkOrderTaskAdHocCostCollectionResourceActionResponse", "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": "GetWorkOrderTaskAdHocCostCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskAdHocCostCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Code" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Description" }, "currencyRateValue": { "title": "currencyRateValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->CurrencyRateValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->FinancialYearPeriod_Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Quantity" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->TransactedOn" }, "totalCostInWorkOrderCurrency": { "title": "totalCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->TotalCostInWorkOrderCurrency" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->TotalCost" }, "unitCost": { "title": "unitCost", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitCost" }, "unitCostInWorkOrderCurrency": { "title": "unitCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitCostInWorkOrderCurrency" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Description" }, "workOrderCurrencyId": { "title": "workOrderCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderCurrency_Id" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderCurrency_Code" }, "workOrderCurrencyDescription": { "title": "workOrderCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderCurrency_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Description" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderStatusId": { "title": "workOrderTaskWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Status_Id" }, "workOrderTaskWorkOrderStatusCode": { "title": "workOrderTaskWorkOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Status_Code" }, "workOrderTaskWorkOrderStatusDescription": { "title": "workOrderTaskWorkOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_WorkOrder_Status_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "GetWorkOrderTaskAdHocCostForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskAdHocCostForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskAdHocCostForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskAdHocCostForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Code" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Description" }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->TransactedOn" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Quantity" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->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" } } } }, "WorkOrderTaskAdHocCostChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskAdHocCostCostCentreLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostCostCentreLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostCostCentreLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->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" } } } }, "WorkOrderTaskAdHocCostCostElementLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostCostElementLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostCostElementLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "WorkOrderTaskAdHocCostFinancialYearPeriodLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostFinancialYearPeriodLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostFinancialYearPeriodLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_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" } } } }, "WorkOrderTaskAdHocCostGeneralLedgerLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostGeneralLedgerLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostGeneralLedgerLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->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" } } } }, "WorkOrderTaskAdHocCostInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskAdHocCostSourceCurrencyLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostSourceCurrencyLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostSourceCurrencyLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostSourceCurrencyLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskAdHocCostSupplierLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostSupplierLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostSupplierLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->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" } } } }, "WorkOrderTaskAdHocCostUnitOfMeasurementLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostUnitOfMeasurementLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostUnitOfMeasurementLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskAdHocCostWorkOrderTaskLookupResourceActionResponse": { "title": "WorkOrderTaskAdHocCostWorkOrderTaskLookupResourceActionResponse", "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": "WorkOrderTaskAdHocCostWorkOrderTaskLookupResourceActionResponseItem", "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": "WorkOrderTaskAdHocCostWorkOrderTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Description" }, "workOrderRequiredBy": { "title": "workOrderRequiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->WorkOrder_RequiredBy" }, "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "CreateWorkOrderTaskAdHocCostResourceActionRequest": { "title": "CreateWorkOrderTaskAdHocCostResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderTaskAdHocCostResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderTaskId" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Id", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->TransactedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->PermissionTree_Id", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Quantity" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->WorkOrderTask_Id" }, "unitCost": { "title": "unitCost", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitCost" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Id", "x-systemGenerated": true }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderTaskAdHocCostResourceActionRequest": { "title": "UpdateWorkOrderTaskAdHocCostResourceActionRequest", "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", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Code" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->CostElement_Id" }, { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Description" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->GeneralLedger_Id" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->FinancialYearPeriod_Id" }, { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskAdHocCost->TransactedOn" }, { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Quantity" }, { "title": "unitCost", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitCost" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskAdHocCost->Currency_Id" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->Supplier_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskAdHocCost->UnitOfMeasurement_Id" } ] } } }, "DeleteWorkOrderTaskAdHocCostResourceActionRequest": { "title": "DeleteWorkOrderTaskAdHocCostResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskAdHocCostResourceAction": { "title": "BatchGetWorkOrderTaskAdHocCostResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Ad Hoc Cost entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Ad Hoc Cost entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskAdHocCostResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskAdHocCostResourceActionRequest": { "title": "BatchCreateWorkOrderTaskAdHocCostResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderTaskAdHocCostResourceActionRequest" } }, "BatchUpdateWorkOrderTaskAdHocCostResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskAdHocCostResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskAdHocCostResourceActionRequest" } }, "BatchDeleteWorkOrderTaskAdHocCostResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskAdHocCostResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskAdHocCostResourceActionRequest" } }, "ChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest", "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": "WorkOrderTaskAdHocCost->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskAdHocCostPermissionTreeResourceActionRequest" } }, "GetWorkOrderTaskDocumentResourceActionResponse": { "title": "GetWorkOrderTaskDocumentResourceActionResponse", "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": "GetWorkOrderTaskDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isCopiedDocumentLink": { "title": "isCopiedDocumentLink", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->IsCopiedDocumentLink" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_TaskDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->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" } } }, "GetWorkOrderTaskDocumentCollectionForWorkOrderTaskResourceActionResponse": { "title": "GetWorkOrderTaskDocumentCollectionForWorkOrderTaskResourceActionResponse", "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": "GetWorkOrderTaskDocumentCollectionForWorkOrderTaskResourceActionResponseItem", "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": "GetWorkOrderTaskDocumentCollectionForWorkOrderTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileType_Extension" }, "isCopiedDocumentLink": { "title": "isCopiedDocumentLink", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->IsCopiedDocumentLink" } } }, "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" } } } }, "GetWorkOrderTaskDocumentCollectionResourceActionResponse": { "title": "GetWorkOrderTaskDocumentCollectionResourceActionResponse", "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": "GetWorkOrderTaskDocumentCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_TaskDescription" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_WorkOrder_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_FileType_Extension" }, "isCopiedDocumentLink": { "title": "isCopiedDocumentLink", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->IsCopiedDocumentLink" } } }, "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" } } } }, "WorkOrderTaskDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskDocumentChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskDocumentDocumentLookupResourceActionResponse": { "title": "WorkOrderTaskDocumentDocumentLookupResourceActionResponse", "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": "WorkOrderTaskDocumentDocumentLookupResourceActionResponseItem", "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": "WorkOrderTaskDocumentDocumentLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "WorkOrderTaskDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskDocumentWorkOrderTaskLookupResourceActionResponse": { "title": "WorkOrderTaskDocumentWorkOrderTaskLookupResourceActionResponse", "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": "WorkOrderTaskDocumentWorkOrderTaskLookupResourceActionResponseItem", "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": "WorkOrderTaskDocumentWorkOrderTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" } } }, "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" } } } }, "CreateWorkOrderTaskDocumentResourceActionRequest": { "title": "CreateWorkOrderTaskDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderTaskDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderTaskId", "documentRecordId" ], "properties": { "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->WorkOrderTask_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderTaskDocumentResourceActionRequest": { "title": "UpdateWorkOrderTaskDocumentResourceActionRequest", "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": "WorkOrderTaskDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskDocument->Notes" } ] } } }, "DeleteWorkOrderTaskDocumentResourceActionRequest": { "title": "DeleteWorkOrderTaskDocumentResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskDocumentResourceAction": { "title": "BatchGetWorkOrderTaskDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Document entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskDocumentResourceActionRequest": { "title": "BatchCreateWorkOrderTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderTaskDocumentResourceActionRequest" } }, "BatchUpdateWorkOrderTaskDocumentResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskDocumentResourceActionRequest" } }, "BatchDeleteWorkOrderTaskDocumentResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskDocumentResourceActionRequest" } }, "ChangeWorkOrderTaskDocumentIsActiveResourceActionRequest": { "title": "ChangeWorkOrderTaskDocumentIsActiveResourceActionRequest", "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": "WorkOrderTaskDocument->IsActive" } ] } } }, "ChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest", "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": "WorkOrderTaskDocument->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeWorkOrderTaskDocumentIsActiveResourceActionRequest": { "title": "BatchChangeWorkOrderTaskDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskDocumentIsActiveResourceActionRequest" } }, "GetWorkOrderTaskFileAttachmentResourceActionResponse": { "title": "GetWorkOrderTaskFileAttachmentResourceActionResponse", "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": "GetWorkOrderTaskFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_TaskDescription" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "WorkOrderTaskFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_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" } } }, "GetWorkOrderTaskFileAttachmentCollectionForWorkOrderTaskResourceActionResponse": { "title": "GetWorkOrderTaskFileAttachmentCollectionForWorkOrderTaskResourceActionResponse", "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": "GetWorkOrderTaskFileAttachmentCollectionForWorkOrderTaskResourceActionResponseItem", "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": "GetWorkOrderTaskFileAttachmentCollectionForWorkOrderTaskResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskFileAttachment->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" } } } }, "GetWorkOrderTaskFileAttachmentCollectionResourceActionResponse": { "title": "GetWorkOrderTaskFileAttachmentCollectionResourceActionResponse", "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": "GetWorkOrderTaskFileAttachmentCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_TaskDescription" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_WorkOrder_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskFileAttachment->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" } } } }, "CreateWorkOrderTaskFileAttachmentResourceActionRequest": { "title": "CreateWorkOrderTaskFileAttachmentResourceActionRequest", "type": "object", "required": [ "workOrderTaskId" ], "properties": { "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkOrderTaskFileAttachmentContentResourceActionRequest": { "title": "UpdateWorkOrderTaskFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkOrderTaskFileAttachmentResourceActionRequest": { "title": "UpdateWorkOrderTaskFileAttachmentResourceActionRequest", "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": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsRestricted" } ] } } }, "DeleteWorkOrderTaskFileAttachmentResourceResourceActionRequest": { "title": "DeleteWorkOrderTaskFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskFileAttachmentResourceAction": { "title": "BatchGetWorkOrderTaskFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task File Attachment entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskFileAttachmentResourceActionResponse" } }, "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" } } }, "GetWorkOrderTaskFileAttachmentContentHistoryResourceActionResponse": { "title": "GetWorkOrderTaskFileAttachmentContentHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetWorkOrderTaskFileAttachmentContentHistoryResourceAction": { "title": "GetWorkOrderTaskFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task File Attachment entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskFileAttachmentResourceActionRequest": { "title": "BatchCreateWorkOrderTaskFileAttachmentResourceActionRequest", "type": "object", "required": [ "workOrderTaskId" ], "properties": { "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->WorkOrderTask_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateWorkOrderTaskFileAttachmentResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskFileAttachmentResourceActionRequest" } }, "BatchDeleteWorkOrderTaskFileAttachmentResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskFileAttachmentResourceResourceActionRequest" } }, "GetWorkOrderTaskMonitoringPointResourceActionResponse": { "title": "GetWorkOrderTaskMonitoringPointResourceActionResponse", "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": "GetWorkOrderTaskMonitoringPointResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPoint_Description" }, "monitoringPointReading": { "title": "monitoringPointReading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReading", "x-NullExpression": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate ne null" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->Notes" }, "workOrderMonitoringPointId": { "title": "workOrderMonitoringPointId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_Id" }, "workOrderMonitoringPointMonitoringPointReadingDate": { "title": "workOrderMonitoringPointMonitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_MonitoringPointReadingDate" }, "workOrderMonitoringPointMonitoringPointReadingValue": { "title": "workOrderMonitoringPointMonitoringPointReadingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_MonitoringPointReadingValue" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskDescription" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_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" } } }, "GetWorkOrderTaskMonitoringPointCollectionResourceActionResponse": { "title": "GetWorkOrderTaskMonitoringPointCollectionResourceActionResponse", "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": "GetWorkOrderTaskMonitoringPointCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskMonitoringPointCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Description" }, "monitoringPointReading": { "title": "monitoringPointReading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReading", "x-NullExpression": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate ne null" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPoint_Description" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode" } } }, "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" } } } }, "GetWorkOrderTaskMonitoringPointForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskMonitoringPointForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskMonitoringPointForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskMonitoringPointForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->PermissionTree_Description" }, "monitoringPointReading": { "title": "monitoringPointReading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReading", "x-NullExpression": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate ne null" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPoint_Code" }, "monitoringPointReadingDate": { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate" }, "workOrderMonitoringPointUpperCriticalBound": { "title": "workOrderMonitoringPointUpperCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_UpperCriticalBound" }, "workOrderMonitoringPointUpperWarningBound": { "title": "workOrderMonitoringPointUpperWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_UpperWarningBound" }, "workOrderMonitoringPointLowerWarningBound": { "title": "workOrderMonitoringPointLowerWarningBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_LowerWarningBound" }, "workOrderMonitoringPointLowerCriticalBound": { "title": "workOrderMonitoringPointLowerCriticalBound", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderMonitoringPoint_LowerCriticalBound" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->WorkOrderTask_TaskCode" } } }, "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" } } } }, "WorkOrderTaskMonitoringPointChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskMonitoringPointChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskMonitoringPointChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskMonitoringPointChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskMonitoringPointInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskMonitoringPointInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskMonitoringPointInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskMonitoringPointInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UpdateWorkOrderTaskMonitoringPointResourceActionRequest": { "title": "UpdateWorkOrderTaskMonitoringPointResourceActionRequest", "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": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMonitoringPoint->Notes" }, { "title": "monitoringPointReadingDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate" }, { "title": "monitoringPointReading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMonitoringPoint->MonitoringPointReading", "x-NullExpression": "WorkOrderTaskMonitoringPoint->MonitoringPointReadingDate ne null" } ] } } }, "BatchGetWorkOrderTaskMonitoringPointResourceAction": { "title": "BatchGetWorkOrderTaskMonitoringPointResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Monitoring Point entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Monitoring Point entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskMonitoringPointResourceActionResponse" } }, "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" } } }, "BatchUpdateWorkOrderTaskMonitoringPointResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskMonitoringPointResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskMonitoringPointResourceActionRequest" } }, "ChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest", "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": "WorkOrderTaskMonitoringPoint->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskMonitoringPointPermissionTreeResourceActionRequest" } }, "GetWorkOrderTaskMovementResourceActionResponse": { "title": "GetWorkOrderTaskMovementResourceActionResponse", "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": "GetWorkOrderTaskMovementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMovement->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->PermissionTree_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Code" }, "workOrderMovementId": { "title": "workOrderMovementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_Id" }, "workOrderMovementWorkOrderId": { "title": "workOrderMovementWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Id" }, "workOrderMovementWorkOrderCode": { "title": "workOrderMovementWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code" }, "workOrderMovementWorkOrderDescription": { "title": "workOrderMovementWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Description" }, "workOrderMovementWorkOrderWorkRequired": { "title": "workOrderMovementWorkOrderWorkRequired", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_WorkRequired" }, "workOrderMovementWorkOrderRequiredBy": { "title": "workOrderMovementWorkOrderRequiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_RequiredBy" }, "workOrderMovementWorkOrderSiteId": { "title": "workOrderMovementWorkOrderSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Site_Id" }, "workOrderMovementWorkOrderSiteCode": { "title": "workOrderMovementWorkOrderSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Site_Code" }, "workOrderMovementWorkOrderCostCentreId": { "title": "workOrderMovementWorkOrderCostCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_CostCentre_Id" }, "workOrderMovementWorkOrderCostCentreCode": { "title": "workOrderMovementWorkOrderCostCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_CostCentre_Code" }, "workOrderMovementWorkOrderGeneralLedgerId": { "title": "workOrderMovementWorkOrderGeneralLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_GeneralLedger_Id" }, "workOrderMovementWorkOrderGeneralLedgerCode": { "title": "workOrderMovementWorkOrderGeneralLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_GeneralLedger_Code" }, "workOrderMovementWorkOrderStatusId": { "title": "workOrderMovementWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_Id" }, "workOrderMovementWorkOrderStatusCode": { "title": "workOrderMovementWorkOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_Code" }, "workOrderMovementWorkOrderStatusBaseStatus": { "title": "workOrderMovementWorkOrderStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskCode" } } }, "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" } } }, "GetWorkOrderTaskMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskDescription" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "GetTaskForWorkOrderMovementCollectionResourceActionResponse": { "title": "GetTaskForWorkOrderMovementCollectionResourceActionResponse", "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": "GetTaskForWorkOrderMovementCollectionResourceActionResponseItem", "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": "GetTaskForWorkOrderMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskDescription" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "GetWorkOrderTaskMovementForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskMovementForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskMovementForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskMovementForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderTask_TaskDescription" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMovement->CreatedOn" }, "workOrderMovementCreatedOn": { "title": "workOrderMovementCreatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_CreatedOn" }, "workOrderMovementCreatedByUserFullName": { "title": "workOrderMovementCreatedByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_CreatedByUser_FullName" }, "workOrderMovementWorkOrderCode": { "title": "workOrderMovementWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrderMovement_WorkOrder_Code" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskMovement->WorkOrder_Code" } } }, "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" } } } }, "BatchGetWorkOrderTaskMovementResourceAction": { "title": "BatchGetWorkOrderTaskMovementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Movement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Movement entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskMovementResourceActionResponse" } }, "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" } } }, "GetWorkOrderTaskResourceResourceActionResponse": { "title": "GetWorkOrderTaskResourceResourceActionResponse", "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": "GetWorkOrderTaskResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Description" }, "disabledReasons": { "title": "disabledReasons", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "WorkOrderTaskDetailDisabledReason" }, "x-propertyPath": "WorkOrderTaskResource->DisabledReasons", "x-formatSpecifier": "WorkOrderTaskDetailDisabledReason" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->IsEnabled" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderStatusId": { "title": "workOrderTaskWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Id" }, "workOrderTaskWorkOrderStatusBaseStatus": { "title": "workOrderTaskWorkOrderStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Id" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Description" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Id" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostElement_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostElement_Code" }, "estimatedUsage": { "title": "estimatedUsage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResource->EstimatedUsage", "x-formatSpecifier": "DynamicValue" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Id" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Proficiency" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->RequiredOn" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Description" }, "resourceTotalCostInResourceCurrency": { "title": "resourceTotalCostInResourceCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->ResourceTotalCostInResourceCurrency" }, "resourceTotalCostInWorkOrderCurrency": { "title": "resourceTotalCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->SequenceNumber" }, "taskResourceId": { "title": "taskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->TaskResourceId" }, "taskResourceType": { "title": "taskResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->TaskResourceType", "x-formatSpecifier": "EntityType" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Id" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Description" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Code" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->UnitOfMeasurement_Description" }, "unitOfMeasurementMeasurementType": { "title": "unitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->UnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "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" } } }, "GetWorkOrderTaskResourceCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Competency_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Description" }, "taskResourceType": { "title": "taskResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->TaskResourceType", "x-formatSpecifier": "EntityType" }, "estimatedUsage": { "title": "estimatedUsage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResource->EstimatedUsage", "x-formatSpecifier": "DynamicValue" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Proficiency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Notes" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->RequiredOn" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->IsEnabled" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Description" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_ContactDetailLastName" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_ContactDetailFirstName" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceSiteCurrencyCode": { "title": "resourceSiteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_Site_Currency_Code" }, "resourceTotalCostInResourceCurrency": { "title": "resourceTotalCostInResourceCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->ResourceTotalCostInResourceCurrency" }, "resourceTotalCostInWorkOrderCurrency": { "title": "resourceTotalCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_Id" }, "workOrderTaskWorkOrderSiteCurrencyCode": { "title": "workOrderTaskWorkOrderSiteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_Currency_Code" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderStatusId": { "title": "workOrderTaskWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Id" }, "workOrderTaskWorkOrderStatusCode": { "title": "workOrderTaskWorkOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Code" }, "workOrderTaskWorkOrderStatusDescription": { "title": "workOrderTaskWorkOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Status_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Trade_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" } } } }, "GetWorkOrderTaskResourceForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->IsEnabled" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskCode" }, "workOrderTaskAssetTaskAssetTreePathItems": { "title": "workOrderTaskAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_AssetTaskAsset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "workOrderTaskAssetTaskComponentTreePathItems": { "title": "workOrderTaskAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_AssetTaskComponent_TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "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" } } } }, "GetWorkOrderTaskResourceForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Competency_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Description" }, "taskResourceType": { "title": "taskResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->TaskResourceType", "x-formatSpecifier": "EntityType" }, "estimatedUsage": { "title": "estimatedUsage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResource->EstimatedUsage", "x-formatSpecifier": "DynamicValue" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Description" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->IsEnabled" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Proficiency" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->RequiredOn" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, "resourceSiteCurrencyCode": { "title": "resourceSiteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_Site_Currency_Code" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_Code" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_ContactDetailLastName" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_ContactDetailFirstName" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceTotalCostInResourceCurrency": { "title": "resourceTotalCostInResourceCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->ResourceTotalCostInResourceCurrency" }, "resourceTotalCostInWorkOrderCurrency": { "title": "resourceTotalCostInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->ResourceTotalCostInWorkOrderCurrency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Trade_Description" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderSiteCurrencyCode": { "title": "workOrderTaskWorkOrderSiteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_Currency_Code" } } }, "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" } } } }, "WorkOrderTaskResourceChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskResourceChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskResourceChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskResourceCompetencyLookupResourceActionResponse": { "title": "WorkOrderTaskResourceCompetencyLookupResourceActionResponse", "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": "WorkOrderTaskResourceCompetencyLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceCompetencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Competency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Competency->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" } } } }, "WorkOrderTaskResourceCostCentreLookupResourceActionResponse": { "title": "WorkOrderTaskResourceCostCentreLookupResourceActionResponse", "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": "WorkOrderTaskResourceCostCentreLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->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" } } } }, "WorkOrderTaskResourceCostElementLookupResourceActionResponse": { "title": "WorkOrderTaskResourceCostElementLookupResourceActionResponse", "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": "WorkOrderTaskResourceCostElementLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "WorkOrderTaskResourceGeneralLedgerLookupResourceActionResponse": { "title": "WorkOrderTaskResourceGeneralLedgerLookupResourceActionResponse", "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": "WorkOrderTaskResourceGeneralLedgerLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->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" } } } }, "WorkOrderTaskResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskResourceInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskResourceInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskResourceResourceLookupResourceActionResponse": { "title": "WorkOrderTaskResourceResourceLookupResourceActionResponse", "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": "WorkOrderTaskResourceResourceLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Resource->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->CostElement_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" } } } }, "WorkOrderTaskResourceSectionLookupResourceActionResponse": { "title": "WorkOrderTaskResourceSectionLookupResourceActionResponse", "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": "WorkOrderTaskResourceSectionLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "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": "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "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": "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "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" } } } }, "WorkOrderTaskResourceTradeLookupResourceActionResponse": { "title": "WorkOrderTaskResourceTradeLookupResourceActionResponse", "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": "WorkOrderTaskResourceTradeLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->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" } } } }, "WorkOrderTaskResourceUnitOfMeasurementLookupResourceActionResponse": { "title": "WorkOrderTaskResourceUnitOfMeasurementLookupResourceActionResponse", "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": "WorkOrderTaskResourceUnitOfMeasurementLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "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" } } } }, "WorkOrderTaskResourceWorkOrderTaskLookupResourceActionResponse": { "title": "WorkOrderTaskResourceWorkOrderTaskLookupResourceActionResponse", "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": "WorkOrderTaskResourceWorkOrderTaskLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceWorkOrderTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Description" }, "workOrderRequiredBy": { "title": "workOrderRequiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->WorkOrder_RequiredBy" }, "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "CreateWorkOrderTaskResourceResourceActionRequest": { "title": "CreateWorkOrderTaskResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderTaskResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requiredOn", "workOrderTaskId" ], "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Id" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Id", "x-systemGenerated": true }, "estimatedUsage": { "title": "estimatedUsage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResource->EstimatedUsage", "x-systemGenerated": true, "x-formatSpecifier": "DynamicValue" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Id", "x-systemGenerated": true }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Proficiency" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->PermissionTree_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Notes" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->SequenceNumber" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->RequiredOn" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Id" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderTaskResourceResourceActionRequest": { "title": "UpdateWorkOrderTaskResourceResourceActionRequest", "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": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Competency_Id" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->CostElement_Id" }, { "title": "estimatedUsage", "format": "composite", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->EstimatedUsage", "x-formatSpecifier": "DynamicValue" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->GeneralLedger_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->RequiredOn" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Id" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Proficiency" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->UnitOfMeasurement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Notes" } ] } } }, "DeleteWorkOrderTaskResourceResourceActionRequest": { "title": "DeleteWorkOrderTaskResourceResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskResourceResourceAction": { "title": "BatchGetWorkOrderTaskResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Resource entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskResourceResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskResourceResourceActionRequest": { "title": "BatchCreateWorkOrderTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderTaskResourceResourceActionRequest" } }, "BatchUpdateWorkOrderTaskResourceResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskResourceResourceActionRequest" } }, "BatchDeleteWorkOrderTaskResourceResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskResourceResourceActionRequest" } }, "ChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest", "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": "WorkOrderTaskResource->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskResourcePermissionTreeResourceActionRequest" } }, "MatchUpdateWorkOrderTaskResourceResourceActionRequest": { "title": "MatchUpdateWorkOrderTaskResourceResourceActionRequest", "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": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResource->RequiredOn" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Trade_Id" } ] } } }, "GetWorkOrderTaskResourceMovementResourceActionResponse": { "title": "GetWorkOrderTaskResourceMovementResourceActionResponse", "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": "GetWorkOrderTaskResourceMovementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceMovement->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrder_Code" }, "workOrderTaskMovementId": { "title": "workOrderTaskMovementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrderTaskMovement_Id" }, "workOrderTaskResourceId": { "title": "workOrderTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrderTaskResource_Id" }, "workOrderTaskResourceResourceId": { "title": "workOrderTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Id" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code" } } }, "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" } } }, "GetWorkOrderTaskResourceMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrder_Description" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "GetWorkOrderTaskResourceMovementForWorkOrderTaskMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceMovementForWorkOrderTaskMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceMovementForWorkOrderTaskMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceMovementForWorkOrderTaskMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrder_Description" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceMovement->WorkOrderTaskResource_Resource_Code" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "BatchGetWorkOrderTaskResourceMovementResourceAction": { "title": "BatchGetWorkOrderTaskResourceMovementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Resource Movement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Resource Movement entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskResourceMovementResourceActionResponse" } }, "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" } } }, "GetWorkOrderTaskResourceUsageResourceActionResponse": { "title": "GetWorkOrderTaskResourceUsageResourceActionResponse", "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": "GetWorkOrderTaskResourceUsageResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceUsage->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceUsage->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->PermissionTree_Description" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceUsage->CompletedOn" }, "costInResourceCurrency": { "title": "costInResourceCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->CostInResourceCurrency" }, "costInResourceRateCurrency": { "title": "costInResourceRateCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->CostInResourceRateCurrency" }, "costInWorkOrderCurrency": { "title": "costInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->CostInWorkOrderCurrency" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateCurrency_Code" }, "financialRateCurrencyDescription": { "title": "financialRateCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateCurrency_Description" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateDescription" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Code" }, "financialRateUnitOfMeasurementDescription": { "title": "financialRateUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_Description" }, "financialRateUnitOfMeasurementMeasurementType": { "title": "financialRateUnitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "financialRateUnitOfMeasurementMeasurementTypeQuantity": { "title": "financialRateUnitOfMeasurementMeasurementTypeQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateUnitOfMeasurement_MeasurementTypeQuantity" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->Notes" }, "resourceCurrencyId": { "title": "resourceCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceCurrency_Id" }, "resourceCurrencyCode": { "title": "resourceCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceCurrency_Code" }, "resourceCurrencyDescription": { "title": "resourceCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceCurrency_Description" }, "resourceRateToResourceCurrencyRateId": { "title": "resourceRateToResourceCurrencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_Id" }, "resourceRateToResourceCurrencyRateAppliedConversionRate": { "title": "resourceRateToResourceCurrencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_AppliedConversionRate" }, "resourceRateToResourceCurrencyRateUserSuppliedConversionRate": { "title": "resourceRateToResourceCurrencyRateUserSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRate_UserSuppliedConversionRate" }, "resourceRateToResourceCurrencyRateValue": { "title": "resourceRateToResourceCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToResourceCurrencyRateValue" }, "resourceRateToWorkOrderCurrencyRateId": { "title": "resourceRateToWorkOrderCurrencyRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_Id" }, "resourceRateToWorkOrderCurrencyRateAppliedConversionRate": { "title": "resourceRateToWorkOrderCurrencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_AppliedConversionRate" }, "resourceRateToWorkOrderCurrencyRateUserSuppliedConversionRate": { "title": "resourceRateToWorkOrderCurrencyRateUserSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_UserSuppliedConversionRate" }, "resourceRateToWorkOrderCurrencyRateValue": { "title": "resourceRateToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue" }, "resourceTradeFinancialRateId": { "title": "resourceTradeFinancialRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_Id" }, "resourceTradeFinancialRateFinancialRateId": { "title": "resourceTradeFinancialRateFinancialRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateId" }, "resourceTradeFinancialRateFinancialRateCurrencyId": { "title": "resourceTradeFinancialRateFinancialRateCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Id" }, "resourceTradeFinancialRateFinancialRateCurrencyCode": { "title": "resourceTradeFinancialRateFinancialRateCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Code" }, "resourceTradeFinancialRateFinancialRateCurrencyDescription": { "title": "resourceTradeFinancialRateFinancialRateCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateCurrency_Description" }, "resourceTradeFinancialRateResourceTradeId": { "title": "resourceTradeFinancialRateResourceTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Id" }, "resourceTradeFinancialRateResourceTradeResourceId": { "title": "resourceTradeFinancialRateResourceTradeResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Id" }, "resourceTradeFinancialRateResourceTradeResourceCode": { "title": "resourceTradeFinancialRateResourceTradeResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Code" }, "resourceTradeFinancialRateResourceTradeTradeId": { "title": "resourceTradeFinancialRateResourceTradeTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Id" }, "resourceTradeFinancialRateResourceTradeTradeCode": { "title": "resourceTradeFinancialRateResourceTradeTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Code" }, "resourceTradeFinancialRateResourceTradeTradeDescription": { "title": "resourceTradeFinancialRateResourceTradeTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Description" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResourceUsage->Usage", "x-formatSpecifier": "DynamicValue" }, "workOrderCurrencyId": { "title": "workOrderCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderCurrency_Id" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderCurrency_Code" }, "workOrderTaskResourceId": { "title": "workOrderTaskResourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Id" }, "workOrderTaskResourceTaskResourceType": { "title": "workOrderTaskResourceTaskResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_TaskResourceType", "x-formatSpecifier": "EntityType" }, "workOrderTaskResourceResourceId": { "title": "workOrderTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code" }, "workOrderTaskResourceResourceDescription": { "title": "workOrderTaskResourceResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Description" }, "workOrderTaskResourceWorkOrderTaskId": { "title": "workOrderTaskResourceWorkOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_Id" }, "workOrderTaskResourceWorkOrderTaskTaskId": { "title": "workOrderTaskResourceWorkOrderTaskTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskId" }, "workOrderTaskResourceWorkOrderTaskTaskCode": { "title": "workOrderTaskResourceWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode" }, "workOrderTaskResourceWorkOrderTaskTaskDescription": { "title": "workOrderTaskResourceWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription" }, "workOrderTaskResourceWorkOrderTaskWorkOrderId": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Id" }, "workOrderTaskResourceWorkOrderTaskWorkOrderCode": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code" }, "workOrderTaskResourceWorkOrderTaskWorkOrderDescription": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_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" } } }, "GetCostingCollectionForWorkOrderTaskResourceUsageResourceActionResponse": { "title": "GetCostingCollectionForWorkOrderTaskResourceUsageResourceActionResponse", "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": "GetCostingCollectionForWorkOrderTaskResourceUsageResourceActionResponseItem", "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": "GetCostingCollectionForWorkOrderTaskResourceUsageResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Description" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->WorkOrderTaskResource_Resource_Code" } } }, "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" } } } }, "GetWorkOrderTaskResourceUsageCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceUsageCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceUsageCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceUsageCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceUsage->CompletedOn" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResourceUsage->Usage", "x-formatSpecifier": "DynamicValue" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Description" }, "financialYearPeriodStartDate": { "title": "financialYearPeriodStartDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_StartDate" }, "financialYearPeriodEndDate": { "title": "financialYearPeriodEndDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_EndDate" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateAmount" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateCurrency_Code" }, "workOrderTaskResourceWorkOrderTaskWorkOrderCode": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code" }, "workOrderTaskResourceWorkOrderTaskWorkOrderDescription": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Description" }, "workOrderTaskResourceWorkOrderTaskWorkOrderStatusId": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Status_Id" }, "workOrderTaskResourceWorkOrderTaskWorkOrderStatusCode": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Status_Code" }, "workOrderTaskResourceWorkOrderTaskWorkOrderStatusDescription": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Status_Description" }, "workOrderTaskResourceWorkOrderTaskTaskCode": { "title": "workOrderTaskResourceWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode" }, "workOrderTaskResourceWorkOrderTaskTaskDescription": { "title": "workOrderTaskResourceWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription" }, "workOrderTaskResourceResourceId": { "title": "workOrderTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code" }, "workOrderTaskResourceResourceContactDetailFirstName": { "title": "workOrderTaskResourceResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailFirstName" }, "workOrderTaskResourceResourceContactDetailLastName": { "title": "workOrderTaskResourceResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailLastName" }, "workOrderTaskResourceTaskResourceType": { "title": "workOrderTaskResourceTaskResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_TaskResourceType", "x-formatSpecifier": "EntityType" }, "resourceRateToWorkOrderCurrencyRateId": { "title": "resourceRateToWorkOrderCurrencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRate_Id" }, "resourceRateToWorkOrderCurrencyRateValue": { "title": "resourceRateToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue" }, "workOrderCurrencyId": { "title": "workOrderCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderCurrency_Id" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderCurrency_Code" }, "workOrderCurrencyDescription": { "title": "workOrderCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderCurrency_Description" }, "resourceTradeFinancialRateResourceTradeResourceCode": { "title": "resourceTradeFinancialRateResourceTradeResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Resource_Code" }, "resourceTradeFinancialRateResourceTradeTradeCode": { "title": "resourceTradeFinancialRateResourceTradeTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Code" }, "resourceTradeFinancialRateResourceTradeTradeDescription": { "title": "resourceTradeFinancialRateResourceTradeTradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_ResourceTrade_Trade_Description" }, "resourceTradeFinancialRateFinancialRateDescription": { "title": "resourceTradeFinancialRateFinancialRateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_FinancialRateDescription" } } }, "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" } } } }, "GetWorkOrderTaskResourceUsageForWorkOrderTaskResourceCollectionResourceActionResponse": { "title": "GetWorkOrderTaskResourceUsageForWorkOrderTaskResourceCollectionResourceActionResponse", "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": "GetWorkOrderTaskResourceUsageForWorkOrderTaskResourceCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskResourceUsageForWorkOrderTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResourceUsage->Usage", "x-formatSpecifier": "DynamicValue" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateAmount" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateCurrency_Code" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialRateDescription" }, "costInResourceRateCurrency": { "title": "costInResourceRateCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->CostInResourceRateCurrency" }, "costInWorkOrderCurrency": { "title": "costInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->CostInWorkOrderCurrency" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderCurrency_Code" }, "workOrderTaskResourceWorkOrderTaskWorkOrderCode": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Code" }, "workOrderTaskResourceWorkOrderTaskWorkOrderDescription": { "title": "workOrderTaskResourceWorkOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_WorkOrder_Description" }, "workOrderTaskResourceWorkOrderTaskTaskCode": { "title": "workOrderTaskResourceWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskCode" }, "workOrderTaskResourceWorkOrderTaskTaskDescription": { "title": "workOrderTaskResourceWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_WorkOrderTask_TaskDescription" }, "workOrderTaskResourceResourceId": { "title": "workOrderTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Id" }, "workOrderTaskResourceResourceCode": { "title": "workOrderTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_Code" }, "workOrderTaskResourceResourceContactDetailFirstName": { "title": "workOrderTaskResourceResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailFirstName" }, "workOrderTaskResourceResourceContactDetailLastName": { "title": "workOrderTaskResourceResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ContactDetailLastName" }, "workOrderTaskResourceResourceResourceType": { "title": "workOrderTaskResourceResourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Resource_ResourceType", "x-formatSpecifier": "ResourceType" } } }, "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" } } } }, "WorkOrderTaskResourceDurationChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskResourceDurationChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskResourceDurationChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceDurationChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskResourceDurationInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskResourceDurationInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskResourceDurationInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceDurationInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskResourceDurationResourceRateLookupResourceActionResponse": { "title": "WorkOrderTaskResourceDurationResourceRateLookupResourceActionResponse", "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": "WorkOrderTaskResourceDurationResourceRateLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceDurationResourceRateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceTradeResourceCode": { "title": "resourceTradeResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Code" }, "resourceTradeTradeId": { "title": "resourceTradeTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Id" }, "resourceTradeTradeCode": { "title": "resourceTradeTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Code" }, "resourceTradeTradeDescription": { "title": "resourceTradeTradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Description" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code" }, "financialRateUnitOfMeasurementDescription": { "title": "financialRateUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Description" }, "financialRateUnitOfMeasurementMeasurementType": { "title": "financialRateUnitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "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" } } } }, "WorkOrderTaskResourceDurationWorkOrderTaskResourceLookupResourceActionResponse": { "title": "WorkOrderTaskResourceDurationWorkOrderTaskResourceLookupResourceActionResponse", "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": "WorkOrderTaskResourceDurationWorkOrderTaskResourceLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceDurationWorkOrderTaskResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "taskResourceType": { "title": "taskResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->TaskResourceType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderSiteFinancialYearPeriodId": { "title": "workOrderTaskWorkOrderSiteFinancialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_FinancialYearPeriod_Id" }, "workOrderTaskWorkOrderSiteFinancialYearPeriodCode": { "title": "workOrderTaskWorkOrderSiteFinancialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_FinancialYearPeriod_Code" }, "workOrderTaskWorkOrderSiteFinancialYearPeriodDescription": { "title": "workOrderTaskWorkOrderSiteFinancialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_WorkOrder_Site_FinancialYearPeriod_Description" }, "workOrderTaskTaskId": { "title": "workOrderTaskTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskId" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->WorkOrderTask_TaskDescription" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResource->Resource_ContactDetailLastName" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" } } }, "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" } } } }, "WorkOrderTaskResourceUsageFinancialYearPeriodLookupResourceActionResponse": { "title": "WorkOrderTaskResourceUsageFinancialYearPeriodLookupResourceActionResponse", "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": "WorkOrderTaskResourceUsageFinancialYearPeriodLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceUsageFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->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" } } } }, "WorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "WorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "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": "WorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "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": "WorkOrderTaskResourceUsageTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "CreateWorkOrderTaskResourceUsageResourceActionRequest": { "title": "CreateWorkOrderTaskResourceUsageResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderTaskResourceUsageResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderTaskResourceId", "usage", "resourceTradeFinancialRateId" ], "properties": { "workOrderTaskResourceId": { "title": "workOrderTaskResourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->WorkOrderTaskResource_Id" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceUsage->CompletedOn" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkOrderTaskResourceUsage->Usage", "x-formatSpecifier": "DynamicValue" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Id" }, "resourceRateToWorkOrderCurrencyRateValue": { "title": "resourceRateToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceRateToWorkOrderCurrencyRateValue" }, "resourceTradeFinancialRateId": { "title": "resourceTradeFinancialRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->ResourceTradeFinancialRate_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->PermissionTree_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderTaskResourceUsageResourceActionRequest": { "title": "UpdateWorkOrderTaskResourceUsageResourceActionRequest", "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": "completedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskResourceUsage->CompletedOn" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "WorkOrderTaskResourceUsage->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->FinancialYearPeriod_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskResourceUsage->Notes" } ] } } }, "DeleteWorkOrderTaskResourceUsageResourceActionRequest": { "title": "DeleteWorkOrderTaskResourceUsageResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskResourceUsageResourceAction": { "title": "BatchGetWorkOrderTaskResourceUsageResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Resource Usage entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Resource Usage entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskResourceUsageResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskResourceUsageResourceActionRequest": { "title": "BatchCreateWorkOrderTaskResourceUsageResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderTaskResourceUsageResourceActionRequest" } }, "BatchUpdateWorkOrderTaskResourceUsageResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskResourceUsageResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskResourceUsageResourceActionRequest" } }, "BatchDeleteWorkOrderTaskResourceUsageResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskResourceUsageResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskResourceUsageResourceActionRequest" } }, "ChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest", "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": "WorkOrderTaskResourceUsage->PermissionTree_Id" } ] } } }, "BatchChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskResourceUsagePermissionTreeResourceActionRequest" } }, "GetWorkOrderTaskSpareResourceActionResponse": { "title": "GetWorkOrderTaskSpareResourceActionResponse", "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": "GetWorkOrderTaskSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Description" }, "disabledReasons": { "title": "disabledReasons", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "WorkOrderTaskDetailDisabledReason" }, "x-propertyPath": "WorkOrderTaskSpare->DisabledReasons", "x-formatSpecifier": "WorkOrderTaskDetailDisabledReason" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->IsEnabled" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Description" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Id" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Description" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Id" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->FinancialYearPeriod_Id" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->FinancialYearPeriod_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->FinancialYearPeriod_Code" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Id" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Code" }, "hasRequisition": { "title": "hasRequisition", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->HasRequisition" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Notes" }, "quantityApprovedOnRequisitions": { "title": "quantityApprovedOnRequisitions", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityApprovedOnRequisitions" }, "quantityOnRequisitions": { "title": "quantityOnRequisitions", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityOnRequisitions" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityRequired" }, "quantityUsed": { "title": "quantityUsed", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityUsed" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->RequiredOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SequenceNumber" }, "spareCurrencyId": { "title": "spareCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SpareCurrency_Id" }, "spareCurrencyCode": { "title": "spareCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SpareCurrency_Code" }, "spareCurrencyDescription": { "title": "spareCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SpareCurrency_Description" }, "spareToWorkOrderCurrencyRateId": { "title": "spareToWorkOrderCurrencyRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id" }, "spareToWorkOrderCurrencyRateUserSuppliedConversionRate": { "title": "spareToWorkOrderCurrencyRateUserSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_UserSuppliedConversionRate" }, "spareToWorkOrderCurrencyRateValue": { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue" }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Id", "x-NullExpression": "WorkOrderTaskSpare->SpareType NE 'StockItem' AND WorkOrderTaskSpare->SpareType NE 'CodedNonStockItem'" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_AlternativeDescription" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Code" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Code" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Id", "x-NullExpression": "WorkOrderTaskSpare->SpareType NE 'StockItem'" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Description" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Code" }, "taskSpareId": { "title": "taskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->TaskSpareId" }, "taskSpareType": { "title": "taskSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TaskSpareType", "x-formatSpecifier": "EntityType" }, "totalRequiredInSpareCurrency": { "title": "totalRequiredInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalRequiredInSpareCurrency" }, "totalRequiredInWorkOrderCurrency": { "title": "totalRequiredInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalRequiredInWorkOrderCurrency" }, "totalUsedInSpareCurrency": { "title": "totalUsedInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalUsedInSpareCurrency" }, "totalUsedInWorkOrderCurrency": { "title": "totalUsedInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalUsedInWorkOrderCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Id" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Description" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Code" }, "unitPriceInSpareCurrency": { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitPriceInSpareCurrency" }, "unitPriceInWorkOrderCurrency": { "title": "unitPriceInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitPriceInWorkOrderCurrency" }, "workOrderCurrencyId": { "title": "workOrderCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderCurrency_Id" }, "workOrderCurrencyDescription": { "title": "workOrderCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderCurrency_Description" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderCurrency_Code" } } }, "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" } } }, "GetRequisitionItemForWorkOrderTaskSpareCollectionResourceActionResponse": { "title": "GetRequisitionItemForWorkOrderTaskSpareCollectionResourceActionResponse", "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": "GetRequisitionItemForWorkOrderTaskSpareCollectionResourceActionResponseItem", "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": "GetRequisitionItemForWorkOrderTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requisitionCode": { "title": "requisitionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareWorkOrderTaskWorkOrderCode": { "title": "workOrderTaskSpareWorkOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_WorkOrder_Code" }, "workOrderTaskSpareWorkOrderTaskTaskCode": { "title": "workOrderTaskSpareWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskCode" }, "workOrderTaskSpareWorkOrderTaskTaskDescription": { "title": "workOrderTaskSpareWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_WorkOrderTask_TaskDescription" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareStockItemMaterialMasterId": { "title": "workOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemMaterialMasterDescription": { "title": "workOrderTaskSpareStockItemMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_MaterialMaster_Description" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "workOrderTaskSpareStockItemWarehouseDescription": { "title": "workOrderTaskSpareStockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_Warehouse_Description" }, "workOrderTaskSpareStockItemAverageItemCost": { "title": "workOrderTaskSpareStockItemAverageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_AverageItemCost" }, "workOrderTaskSpareStockItemQuantityOnHand": { "title": "workOrderTaskSpareStockItemQuantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_StockItem_QuantityOnHand" }, "workOrderTaskSpareSupplierCode": { "title": "workOrderTaskSpareSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Code" }, "workOrderTaskSpareSupplierDescription": { "title": "workOrderTaskSpareSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_Supplier_Description" }, "workOrderTaskSpareUnitPriceInSpareCurrency": { "title": "workOrderTaskSpareUnitPriceInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_UnitPriceInSpareCurrency" }, "workOrderTaskSpareTotalUsedInWorkOrderCurrency": { "title": "workOrderTaskSpareTotalUsedInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_TotalUsedInWorkOrderCurrency" }, "quantityIssued": { "title": "quantityIssued", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityIssued" }, "quantityNotIssued": { "title": "quantityNotIssued", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityNotIssued" } } }, "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" } } } }, "GetWorkOrderTaskSpareCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSpareCollectionResourceActionResponse", "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": "GetWorkOrderTaskSpareCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Code" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Description" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityRequired" }, "quantityUsed": { "title": "quantityUsed", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityUsed" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->IsEnabled" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->RequiredOn" }, "spareCurrencyId": { "title": "spareCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SpareCurrency_Id" }, "spareCurrencyCode": { "title": "spareCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareCurrency_Code" }, "spareCurrencyDescription": { "title": "spareCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareCurrency_Description" }, "spareToWorkOrderCurrencyRateId": { "title": "spareToWorkOrderCurrencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id" }, "spareToWorkOrderCurrencyRateSourceCurrencyCode": { "title": "spareToWorkOrderCurrencyRateSourceCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_SourceCurrency_Code" }, "spareToWorkOrderCurrencyRateSourceCurrencyDescription": { "title": "spareToWorkOrderCurrencyRateSourceCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_SourceCurrency_Description" }, "spareToWorkOrderCurrencyRateValue": { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_AlternativeDescription" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Description" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SequenceNumber" }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "taskSpareId": { "title": "taskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->TaskSpareId" }, "taskSpareType": { "title": "taskSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TaskSpareType", "x-formatSpecifier": "EntityType" }, "totalRequiredInSpareCurrency": { "title": "totalRequiredInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalRequiredInSpareCurrency" }, "totalRequiredInWorkOrderCurrency": { "title": "totalRequiredInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalRequiredInWorkOrderCurrency" }, "totalUsedInSpareCurrency": { "title": "totalUsedInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalUsedInSpareCurrency" }, "totalUsedInWorkOrderCurrency": { "title": "totalUsedInWorkOrderCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TotalUsedInWorkOrderCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Description" }, "workOrderCurrencyId": { "title": "workOrderCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderCurrency_Id" }, "workOrderCurrencyCode": { "title": "workOrderCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderCurrency_Code" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderStatusId": { "title": "workOrderTaskWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Status_Id" }, "workOrderTaskWorkOrderStatusCode": { "title": "workOrderTaskWorkOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Status_Code" }, "workOrderTaskWorkOrderStatusDescription": { "title": "workOrderTaskWorkOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_WorkOrder_Status_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "GetWorkOrderTaskSpareForWorkOrderCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSpareForWorkOrderCollectionResourceActionResponse", "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": "GetWorkOrderTaskSpareForWorkOrderCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSpareForWorkOrderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_TaskCode" }, "workOrderTaskAssetTreePathItems": { "title": "workOrderTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_AssetTreePathItems", "x-formatSpecifier": "TreePathItem" }, "workOrderTaskComponentTreePathItems": { "title": "workOrderTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_ComponentTreePathItems", "x-formatSpecifier": "TreePathItem" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Description" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->IsEnabled" }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Description" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Code" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityRequired" }, "quantityUsed": { "title": "quantityUsed", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityUsed" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->RequiredOn" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->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" } } } }, "GetWorkOrderTaskSpareForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSpareForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskSpareForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSpareForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Code" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Description" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Description" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Description" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->IsEnabled" }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityRequired" }, "quantityUsed": { "title": "quantityUsed", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityUsed" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->RequiredOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SequenceNumber" }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_AlternativeDescription" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_MaterialMaster_Description" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Warehouse_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Description" }, "taskSpareType": { "title": "taskSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->TaskSpareType", "x-formatSpecifier": "EntityType" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->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" } } } }, "WorkOrderTaskSpareAssetStockItemLookupResourceActionResponse": { "title": "WorkOrderTaskSpareAssetStockItemLookupResourceActionResponse", "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": "WorkOrderTaskSpareAssetStockItemLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareAssetStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "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" } } } }, "WorkOrderTaskSpareChangePermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskSpareChangePermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskSpareChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskSpareCodedNonStockItemForSiteLookupResourceActionResponse": { "title": "WorkOrderTaskSpareCodedNonStockItemForSiteLookupResourceActionResponse", "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": "WorkOrderTaskSpareCodedNonStockItemForSiteLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareCodedNonStockItemForSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "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" } } } }, "WorkOrderTaskSpareCodedNonStockItemLookupResourceActionResponse": { "title": "WorkOrderTaskSpareCodedNonStockItemLookupResourceActionResponse", "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": "WorkOrderTaskSpareCodedNonStockItemLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareCodedNonStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "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" } } } }, "WorkOrderTaskSpareCostCentreLookupResourceActionResponse": { "title": "WorkOrderTaskSpareCostCentreLookupResourceActionResponse", "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": "WorkOrderTaskSpareCostCentreLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->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" } } } }, "WorkOrderTaskSpareCostElementLookupResourceActionResponse": { "title": "WorkOrderTaskSpareCostElementLookupResourceActionResponse", "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": "WorkOrderTaskSpareCostElementLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "WorkOrderTaskSpareFinancialYearPeriodLookupResourceActionResponse": { "title": "WorkOrderTaskSpareFinancialYearPeriodLookupResourceActionResponse", "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": "WorkOrderTaskSpareFinancialYearPeriodLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_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" } } } }, "WorkOrderTaskSpareGeneralLedgerLookupResourceActionResponse": { "title": "WorkOrderTaskSpareGeneralLedgerLookupResourceActionResponse", "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": "WorkOrderTaskSpareGeneralLedgerLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->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" } } } }, "WorkOrderTaskSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkOrderTaskSpareInsertPermissionTreeLookupResourceActionResponse", "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": "WorkOrderTaskSpareInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskSpareRequesterContactLookupResourceActionResponse": { "title": "WorkOrderTaskSpareRequesterContactLookupResourceActionResponse", "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": "WorkOrderTaskSpareRequesterContactLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareRequesterContactLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "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" } } } }, "WorkOrderTaskSpareSpareCurrencyLookupResourceActionResponse": { "title": "WorkOrderTaskSpareSpareCurrencyLookupResourceActionResponse", "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": "WorkOrderTaskSpareSpareCurrencyLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareSpareCurrencyLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskSpareStockItemForSiteLookupResourceActionResponse": { "title": "WorkOrderTaskSpareStockItemForSiteLookupResourceActionResponse", "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": "WorkOrderTaskSpareStockItemForSiteLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareStockItemForSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "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" } } } }, "WorkOrderTaskSpareStockItemLookupResourceActionResponse": { "title": "WorkOrderTaskSpareStockItemLookupResourceActionResponse", "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": "WorkOrderTaskSpareStockItemLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "defaultStockItemSupplierSupplierId": { "title": "defaultStockItemSupplierSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Id" }, "defaultStockItemSupplierSupplierCode": { "title": "defaultStockItemSupplierSupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Code" }, "defaultStockItemSupplierSupplierDescription": { "title": "defaultStockItemSupplierSupplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->DefaultStockItemSupplier_Supplier_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->UnitOfMeasurement_Description" }, "averageItemCost": { "title": "averageItemCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->AverageItemCost" }, "quantityOnHand": { "title": "quantityOnHand", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StockItem->QuantityOnHand" } } }, "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" } } } }, "WorkOrderTaskSpareSupplierLookupResourceActionResponse": { "title": "WorkOrderTaskSpareSupplierLookupResourceActionResponse", "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": "WorkOrderTaskSpareSupplierLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->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" } } } }, "WorkOrderTaskSpareUnitOfMeasurementLookupResourceActionResponse": { "title": "WorkOrderTaskSpareUnitOfMeasurementLookupResourceActionResponse", "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": "WorkOrderTaskSpareUnitOfMeasurementLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskSpareWorkOrderCurrencyLookupResourceActionResponse": { "title": "WorkOrderTaskSpareWorkOrderCurrencyLookupResourceActionResponse", "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": "WorkOrderTaskSpareWorkOrderCurrencyLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareWorkOrderCurrencyLookupResourceActionResponseItemProperties", "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" } } } }, "WorkOrderTaskSpareWorkOrderTaskLookupResourceActionResponse": { "title": "WorkOrderTaskSpareWorkOrderTaskLookupResourceActionResponse", "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": "WorkOrderTaskSpareWorkOrderTaskLookupResourceActionResponseItem", "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": "WorkOrderTaskSpareWorkOrderTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTask->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTask->WorkOrder_Description" }, "workOrderRequiredBy": { "title": "workOrderRequiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTask->WorkOrder_RequiredBy" }, "taskCode": { "title": "taskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskCode" }, "taskDescription": { "title": "taskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTask->TaskDescription" }, "taskType": { "title": "taskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTask->TaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "CreateWorkOrderTaskSpareResourceActionRequest": { "title": "CreateWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "quantityRequired", "requiredOn", "spareType", "workOrderTaskId" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Code" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Id", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Description" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->FinancialYearPeriod_Id", "x-systemGenerated": true }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->PermissionTree_Id", "x-systemGenerated": true }, "quantityRequired": { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityRequired" }, "quantityUsed": { "title": "quantityUsed", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityUsed" }, "requiredOn": { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->RequiredOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SequenceNumber" }, "spareToWorkOrderCurrencyRateValue": { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRateValue", "x-systemGenerated": true }, "spareType": { "title": "spareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->StockItem_Id", "x-NullExpression": "WorkOrderTaskSpare->SpareType NE 'StockItem' AND WorkOrderTaskSpare->SpareType NE 'CodedNonStockItem'" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Id", "x-NullExpression": "WorkOrderTaskSpare->SpareType NE 'StockItem'" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Id" }, "unitPriceInSpareCurrency": { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitPriceInSpareCurrency" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->WorkOrderTask_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkOrderTaskSpareResourceActionRequest": { "title": "UpdateWorkOrderTaskSpareResourceActionRequest", "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", "readOnly": true, "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Code", "x-ReadOnlyExpression": "WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem'" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->CostElement_Id" }, { "title": "description", "type": "string", "readOnly": true, "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Description", "x-ReadOnlyExpression": "WorkOrderTaskSpare->SpareType EQ 'StockItem' OR WorkOrderTaskSpare->SpareType EQ 'CodedNonStockItem'" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->GeneralLedger_Id" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->FinancialYearPeriod_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->SequenceNumber" }, { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpare->RequiredOn" }, { "title": "quantityRequired", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityRequired" }, { "title": "quantityUsed", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->QuantityUsed" }, { "title": "spareToWorkOrderCurrencyRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->SpareToWorkOrderCurrencyRate_Id" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->Supplier_Id", "x-NullExpression": "WorkOrderTaskSpare->SpareType NE 'StockItem'" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpare->UnitOfMeasurement_Id" }, { "title": "unitPriceInSpareCurrency", "type": "number", "readOnly": true, "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpare->UnitPriceInSpareCurrency", "x-ReadOnlyExpression": "WorkOrderTaskSpare->SpareType EQ 'StockItem'" } ] } } }, "DeleteWorkOrderTaskSpareResourceActionRequest": { "title": "DeleteWorkOrderTaskSpareResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskSpareResourceAction": { "title": "BatchGetWorkOrderTaskSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Spare entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskSpareResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskSpareResourceActionRequest": { "title": "BatchCreateWorkOrderTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkOrderTaskSpareResourceActionRequest" } }, "RequisitionItem": { "title": "RequisitionItem", "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", "x-nullable": true, "x-propertyPath": "RequisitionItem->Code" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->CostElement_Id" }, { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->Description" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->FinancialYearPeriod_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->GeneralLedger_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RequisitionItem->Notes" }, { "title": "quantityRequired", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RequisitionItem->QuantityRequired" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequisitionItem->SequenceNumber" }, { "title": "quantityOrdered", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "RequisitionItem->QuantityOrdered" }, { "title": "quantityReserved", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->QuantityReserved" }, { "title": "requiredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequisitionItem->RequiredOn" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequisitionItem->SequenceNumber" }, { "title": "spareToWorkOrderCurrencyRateValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->SpareToWorkOrderCurrencyRateValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->Supplier_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequisitionItem->UnitOfMeasurement_Id" }, { "title": "unitPriceInSpareCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RequisitionItem->UnitPriceInSpareCurrency" } ] } } }, "BatchUpdateWorkOrderTaskSpareRequisitionItemResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskSpareRequisitionItemResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/RequisitionItem" } }, "BatchUpdateWorkOrderTaskSpareResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskSpareResourceActionRequest" } }, "BatchDeleteWorkOrderTaskSpareResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskSpareResourceActionRequest" } }, "AddSpareToNewRequisitionForWorkTaskSpareResourceActionRequest": { "title": "AddSpareToNewRequisitionForWorkTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AddSpareToNewRequisitionForWorkTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requesterType" ], "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Code", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->PermissionTree_Id", "x-systemGenerated": true }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AddSpareToNewRequisition->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->RequesterContact_Id" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Requester" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddSpareToNewRequisition->RequestedOn", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "AddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequest": { "title": "AddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "requisitionId" ], "properties": { "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AddSpareToRequisition->Requisition_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAddSpareToNewRequisitionForWorkOrderTaskSpareResourceActionRequest": { "title": "BatchAddSpareToNewRequisitionForWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchAddSpareToNewRequisitionForWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds", "requesterType", "requestedOn" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "AddSpareToNewRequisition->EntityIds", "x-formatSpecifier": "Int64" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Code", "x-systemGenerated": true }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AddSpareToNewRequisition->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->RequesterContact_Id" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Requester" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddSpareToNewRequisition->RequestedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddSpareToNewRequisition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequest": { "title": "BatchAddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchAddSpareToRequisitionForWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "AddSpareToRequisition->EntityIds", "x-formatSpecifier": "Int64" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddSpareToRequisition->Requisition_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchIssueAllWorkOrderTaskSpareResourceActionRequest": { "title": "BatchIssueAllWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchIssueAllWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchReturnAllWorkOrderTaskSpareResourceActionRequest": { "title": "BatchReturnAllWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchReturnAllWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityIds" ], "properties": { "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IssueReturnAll->EntityIds", "x-formatSpecifier": "Int64" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeWorkOrderTaskSparePermissionTreeResourceActionRequest": { "title": "ChangeWorkOrderTaskSparePermissionTreeResourceActionRequest", "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": "WorkOrderTaskSpare->PermissionTree_Id" } ] } } }, "IssueAllWorkOrderTaskSpareResourceActionRequest": { "title": "IssueAllWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "IssueAllWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ReturnAllWorkOrderTaskSpareResourceActionRequest": { "title": "ReturnAllWorkOrderTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ReturnAllWorkOrderTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->Permission_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "IssueReturnAll->FinancialYearPeriod_Id", "x-systemGenerated": true }, "transactedOn": { "title": "transactedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "IssueReturnAll->TransactedOn", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeWorkOrderTaskSparePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkOrderTaskSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkOrderTaskSparePermissionTreeResourceActionRequest" } }, "GetWorkOrderTaskSpareFileAttachmentResourceActionResponse": { "title": "GetWorkOrderTaskSpareFileAttachmentResourceActionResponse", "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": "GetWorkOrderTaskSpareFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_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" } } }, "GetWorkOrderTaskSpareFileAttachmentCollectionForWorkOrderTaskSpareResourceActionResponse": { "title": "GetWorkOrderTaskSpareFileAttachmentCollectionForWorkOrderTaskSpareResourceActionResponse", "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": "GetWorkOrderTaskSpareFileAttachmentCollectionForWorkOrderTaskSpareResourceActionResponseItem", "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": "GetWorkOrderTaskSpareFileAttachmentCollectionForWorkOrderTaskSpareResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->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" } } } }, "GetWorkOrderTaskSpareFileAttachmentCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSpareFileAttachmentCollectionResourceActionResponse", "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": "GetWorkOrderTaskSpareFileAttachmentCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSpareFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareFileAttachment->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" } } } }, "CreateWorkOrderTaskSpareFileAttachmentResourceActionRequest": { "title": "CreateWorkOrderTaskSpareFileAttachmentResourceActionRequest", "type": "object", "required": [ "workOrderTaskSpareId" ], "properties": { "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkOrderTaskSpareFileAttachmentContentResourceActionRequest": { "title": "UpdateWorkOrderTaskSpareFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest": { "title": "UpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest", "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": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsRestricted" } ] } } }, "DeleteWorkOrderTaskSpareFileAttachmentResourceResourceActionRequest": { "title": "DeleteWorkOrderTaskSpareFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetWorkOrderTaskSpareFileAttachmentResourceAction": { "title": "BatchGetWorkOrderTaskSpareFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Spare File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Spare File Attachment entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskSpareFileAttachmentResourceActionResponse" } }, "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" } } }, "GetWorkOrderTaskSpareFileAttachmentContentHistoryResourceActionResponse": { "title": "GetWorkOrderTaskSpareFileAttachmentContentHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetWorkOrderTaskSpareFileAttachmentContentHistoryResourceAction": { "title": "GetWorkOrderTaskSpareFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Spare File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Spare File Attachment entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskSpareFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateWorkOrderTaskSpareFileAttachmentResourceActionRequest": { "title": "BatchCreateWorkOrderTaskSpareFileAttachmentResourceActionRequest", "type": "object", "required": [ "workOrderTaskSpareId" ], "properties": { "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->WorkOrderTaskSpare_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskSpareFileAttachmentResourceActionRequest" } }, "BatchDeleteWorkOrderTaskSpareFileAttachmentResourceActionRequest": { "title": "BatchDeleteWorkOrderTaskSpareFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkOrderTaskSpareFileAttachmentResourceResourceActionRequest" } }, "GetWorkOrderTaskSpareMovementResourceActionResponse": { "title": "GetWorkOrderTaskSpareMovementResourceActionResponse", "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": "GetWorkOrderTaskSpareMovementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSpareMovement->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrder_Code" }, "workOrderTaskMovementId": { "title": "workOrderTaskMovementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskMovement_Id" }, "workOrderTaskSpareId": { "title": "workOrderTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Id" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareStockItemId": { "title": "workOrderTaskSpareStockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Id" }, "workOrderTaskSpareStockItemMaterialMasterId": { "title": "workOrderTaskSpareStockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Id" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemWarehouseId": { "title": "workOrderTaskSpareStockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Id" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code" } } }, "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" } } }, "GetWorkOrderTaskSpareMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSpareMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskSpareMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSpareMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrder_Description" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "GetWorkOrderTaskSpareMovementForWorkOrderTaskMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSpareMovementForWorkOrderTaskMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskSpareMovementForWorkOrderTaskMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSpareMovementForWorkOrderTaskMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrder_Description" }, "workOrderTaskSpareCode": { "title": "workOrderTaskSpareCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Code" }, "workOrderTaskSpareDescription": { "title": "workOrderTaskSpareDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_Description" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "workOrderTaskSpareStockItemMaterialMasterCode": { "title": "workOrderTaskSpareStockItemMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_MaterialMaster_Code" }, "workOrderTaskSpareStockItemWarehouseCode": { "title": "workOrderTaskSpareStockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSpareMovement->WorkOrderTaskSpare_StockItem_Warehouse_Code" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSpareMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "BatchGetWorkOrderTaskSpareMovementResourceAction": { "title": "BatchGetWorkOrderTaskSpareMovementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Spare Movement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Spare Movement entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskSpareMovementResourceActionResponse" } }, "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" } } }, "GetWorkOrderTaskSubTaskResourceActionResponse": { "title": "GetWorkOrderTaskSubTaskResourceActionResponse", "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": "GetWorkOrderTaskSubTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->ModifiedOn" }, "disabledReasons": { "title": "disabledReasons", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "WorkOrderTaskDetailDisabledReason" }, "x-propertyPath": "WorkOrderTaskSubTask->DisabledReasons", "x-formatSpecifier": "WorkOrderTaskDetailDisabledReason" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->IsEnabled" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->AlternativeDescription" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->CompletedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->SequenceNumber" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->StartedOn" }, "taskSubTaskId": { "title": "taskSubTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->TaskSubTaskId" }, "taskSubTaskType": { "title": "taskSubTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->TaskSubTaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } }, "GetWorkOrderTaskSubTaskForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSubTaskForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskSubTaskForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSubTaskForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->AlternativeDescription" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->SequenceNumber" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->CompletedOn" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->IsEnabled" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->StartedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Notes" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "taskSubTaskType": { "title": "taskSubTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->TaskSubTaskType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "GetWorkOrderTaskSubTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSubTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskSubTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSubTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->AlternativeDescription" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Code" }, "completed": { "title": "completed", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Completed" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->CompletedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->SequenceNumber" }, "taskSubTaskId": { "title": "taskSubTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->TaskSubTaskId" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->StartedOn" }, "taskSubTaskType": { "title": "taskSubTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->TaskSubTaskType", "x-formatSpecifier": "EntityType" }, "isEnabled": { "title": "isEnabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->IsEnabled" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Notes" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Description" }, "workOrderTaskWorkOrderStatusId": { "title": "workOrderTaskWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Status_Id" }, "workOrderTaskWorkOrderStatusCode": { "title": "workOrderTaskWorkOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Status_Code" }, "workOrderTaskWorkOrderStatusDescription": { "title": "workOrderTaskWorkOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_WorkOrder_Status_Description" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskDescription" }, "workOrderTaskTaskType": { "title": "workOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTask->WorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->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" } } } }, "UpdateWorkOrderTaskSubTaskResourceActionRequest": { "title": "UpdateWorkOrderTaskSubTaskResourceActionRequest", "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": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->SequenceNumber" }, { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->StartedOn" }, { "title": "completed", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTask->Completed" }, { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTask->CompletedOn" } ] } } }, "BatchGetWorkOrderTaskSubTaskResourceAction": { "title": "BatchGetWorkOrderTaskSubTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Sub Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Sub Task entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskResourceActionResponse" } }, "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" } } }, "BatchUpdateWorkOrderTaskSubTaskResourceActionRequest": { "title": "BatchUpdateWorkOrderTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkOrderTaskSubTaskResourceActionRequest" } }, "GetWorkOrderTaskSubTaskMovementResourceActionResponse": { "title": "GetWorkOrderTaskSubTaskMovementResourceActionResponse", "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": "GetWorkOrderTaskSubTaskMovementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskSubTaskMovement->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrder_Code" }, "workOrderTaskMovementId": { "title": "workOrderTaskMovementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrderTaskMovement_Id" }, "workOrderTaskSubTaskId": { "title": "workOrderTaskSubTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_Id" }, "workOrderTaskSubTaskWorkOrderTaskId": { "title": "workOrderTaskSubTaskWorkOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_WorkOrderTask_Id" }, "workOrderTaskSubTaskWorkOrderTaskTaskCode": { "title": "workOrderTaskSubTaskWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrderTaskSubTask_WorkOrderTask_TaskCode" } } }, "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" } } }, "GetWorkOrderTaskSubTaskMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSubTaskMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskSubTaskMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSubTaskMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrder_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "GetWorkOrderTaskSubTaskMovementForWorkOrderTaskMovementCollectionResourceActionResponse": { "title": "GetWorkOrderTaskSubTaskMovementForWorkOrderTaskMovementCollectionResourceActionResponse", "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": "GetWorkOrderTaskSubTaskMovementForWorkOrderTaskMovementCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskSubTaskMovementForWorkOrderTaskMovementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->PermissionTree_Description" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskSubTaskMovement->WorkOrder_Description" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Action", "x-formatSpecifier": "WorkOrderMovementAction" }, "direction": { "title": "direction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Direction", "x-formatSpecifier": "WorkOrderMovementDirection" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskSubTaskMovement->Result", "x-formatSpecifier": "WorkOrderMovementResult" } } }, "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" } } } }, "BatchGetWorkOrderTaskSubTaskMovementResourceAction": { "title": "BatchGetWorkOrderTaskSubTaskMovementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Sub Task Movement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Sub Task Movement entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskSubTaskMovementResourceActionResponse" } }, "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" } } }, "GetWorkOrderTaskWarrantyResourceActionResponse": { "title": "GetWorkOrderTaskWarrantyResourceActionResponse", "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": "GetWorkOrderTaskWarrantyResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskWarranty->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderTaskWarranty->ModifiedOn" }, "workOrderWarrantyId": { "title": "workOrderWarrantyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Id" }, "workOrderWarrantyWarranty": { "title": "workOrderWarrantyWarranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Warranty", "x-formatSpecifier": "Warranty" }, "workOrderWarrantySupplierId": { "title": "workOrderWarrantySupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Id" }, "workOrderWarrantySupplierCode": { "title": "workOrderWarrantySupplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code" }, "workOrderWarrantySupplierDescription": { "title": "workOrderWarrantySupplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Description" }, "workOrderWarrantyAssetWarrantyId": { "title": "workOrderWarrantyAssetWarrantyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Id" }, "workOrderWarrantyAssetWarrantyCode": { "title": "workOrderWarrantyAssetWarrantyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code" }, "workOrderWarrantyAssetWarrantyDescription": { "title": "workOrderWarrantyAssetWarrantyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description" }, "workOrderWarrantyAssetWarrantyWarrantyTypeId": { "title": "workOrderWarrantyAssetWarrantyWarrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Id" }, "workOrderWarrantyAssetWarrantyWarrantyTypeCode": { "title": "workOrderWarrantyAssetWarrantyWarrantyTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code" }, "workOrderWarrantyAssetWarrantyWarrantyTypeDescription": { "title": "workOrderWarrantyAssetWarrantyWarrantyTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Description" }, "workOrderWarrantyAssetWarrantyWarrantyExpiryDate": { "title": "workOrderWarrantyAssetWarrantyWarrantyExpiryDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate" }, "workOrderTaskId": { "title": "workOrderTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_Id" }, "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_TaskCode" }, "workOrderTaskTaskDescription": { "title": "workOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_TaskDescription" }, "workOrderTaskWorkOrderId": { "title": "workOrderTaskWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Id" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Code" }, "workOrderTaskWorkOrderDescription": { "title": "workOrderTaskWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_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" } } }, "GetWorkOrderTaskWarrantyForWorkOrderTaskCollectionResourceActionResponse": { "title": "GetWorkOrderTaskWarrantyForWorkOrderTaskCollectionResourceActionResponse", "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": "GetWorkOrderTaskWarrantyForWorkOrderTaskCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskWarrantyForWorkOrderTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderWarrantyAssetWarrantyCode": { "title": "workOrderWarrantyAssetWarrantyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code" }, "workOrderWarrantyAssetWarrantyDescription": { "title": "workOrderWarrantyAssetWarrantyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description" }, "workOrderWarrantyAssetWarrantyWarrantyTypeCode": { "title": "workOrderWarrantyAssetWarrantyWarrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code" }, "workOrderWarrantyAssetWarrantyWarrantyExpiryDate": { "title": "workOrderWarrantyAssetWarrantyWarrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate" }, "workOrderWarrantySupplierCode": { "title": "workOrderWarrantySupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code" }, "workOrderWarrantyWarranty": { "title": "workOrderWarrantyWarranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } } }, "GetWorkOrderTaskWarrantyCollectionResourceActionResponse": { "title": "GetWorkOrderTaskWarrantyCollectionResourceActionResponse", "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": "GetWorkOrderTaskWarrantyCollectionResourceActionResponseItem", "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": "GetWorkOrderTaskWarrantyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workOrderTaskTaskCode": { "title": "workOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_TaskCode" }, "workOrderTaskWorkOrderCode": { "title": "workOrderTaskWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderTask_WorkOrder_Code" }, "workOrderWarrantyAssetWarrantyCode": { "title": "workOrderWarrantyAssetWarrantyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Code" }, "workOrderWarrantyAssetWarrantyDescription": { "title": "workOrderWarrantyAssetWarrantyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_Description" }, "workOrderWarrantyAssetWarrantyWarrantyTypeCode": { "title": "workOrderWarrantyAssetWarrantyWarrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyType_Code" }, "workOrderWarrantyAssetWarrantyWarrantyExpiryDate": { "title": "workOrderWarrantyAssetWarrantyWarrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_AssetWarranty_WarrantyExpiryDate" }, "workOrderWarrantySupplierCode": { "title": "workOrderWarrantySupplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Supplier_Code" }, "workOrderWarrantyWarranty": { "title": "workOrderWarrantyWarranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderTaskWarranty->WorkOrderWarranty_Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } } }, "BatchGetWorkOrderTaskWarrantyResourceAction": { "title": "BatchGetWorkOrderTaskWarrantyResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Task Warranty entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Task Warranty entities", "items": { "$ref": "#/definitions/GetWorkOrderTaskWarrantyResourceActionResponse" } }, "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" } } }, "GetWorkOrderWarrantyResourceActionResponse": { "title": "GetWorkOrderWarrantyResourceActionResponse", "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": "GetWorkOrderWarrantyResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderWarranty->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrderWarranty->ModifiedOn" }, "assetWarrantyId": { "title": "assetWarrantyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Id" }, "assetWarrantyCode": { "title": "assetWarrantyCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Code" }, "assetWarrantyDescription": { "title": "assetWarrantyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Description" }, "assetWarrantyWarrantyExpiryDate": { "title": "assetWarrantyWarrantyExpiryDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "WorkOrderWarranty->AssetWarranty_WarrantyExpiryDate" }, "assetWarrantyWarrantyTypeId": { "title": "assetWarrantyWarrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_WarrantyType_Id" }, "assetWarrantyWarrantyTypeCode": { "title": "assetWarrantyWarrantyTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_WarrantyType_Code" }, "assetWarrantyWarrantyTypeDescription": { "title": "assetWarrantyWarrantyTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_WarrantyType_Description" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->Warranty", "x-formatSpecifier": "Warranty" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->Supplier_Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderWarranty->WarrantyExpiryDate" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->WorkOrder_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" } } }, "GetWorkOrderWarrantyCollectionForWorkOrderResourceActionResponse": { "title": "GetWorkOrderWarrantyCollectionForWorkOrderResourceActionResponse", "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": "GetWorkOrderWarrantyCollectionForWorkOrderResourceActionResponseItem", "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": "GetWorkOrderWarrantyCollectionForWorkOrderResourceActionResponseItemProperties", "type": "object", "properties": { "assetWarrantyCode": { "title": "assetWarrantyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Code" }, "assetWarrantyDescription": { "title": "assetWarrantyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Description" }, "assetWarrantyWarrantyTypeCode": { "title": "assetWarrantyWarrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_WarrantyType_Code" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderWarranty->WarrantyExpiryDate" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->Supplier_Code" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } } }, "GetWorkOrderWarrantyCollectionResourceActionResponse": { "title": "GetWorkOrderWarrantyCollectionResourceActionResponse", "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": "GetWorkOrderWarrantyCollectionResourceActionResponseItem", "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": "GetWorkOrderWarrantyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetWarrantyCode": { "title": "assetWarrantyCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Code" }, "assetWarrantyDescription": { "title": "assetWarrantyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_Description" }, "assetWarrantyWarrantyTypeCode": { "title": "assetWarrantyWarrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->AssetWarranty_WarrantyType_Code" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->WorkOrder_Code" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "WorkOrderWarranty->WarrantyExpiryDate" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderWarranty->Supplier_Code" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrderWarranty->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } } }, "BatchGetWorkOrderWarrantyResourceAction": { "title": "BatchGetWorkOrderWarrantyResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Order Warranty entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Order Warranty entities", "items": { "$ref": "#/definitions/GetWorkOrderWarrantyResourceActionResponse" } }, "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" } } }, "GetWorkRequestResourceActionResponse": { "title": "GetWorkRequestResourceActionResponse", "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": "GetWorkRequestResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkRequest->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicUnitOfMeasurement_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Code" }, "codeCounter": { "title": "codeCounter", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->CodeCounter" }, "codePrefix": { "title": "codePrefix", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->CodePrefix" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Site_Description" }, "requester": { "title": "requester", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Requester", "x-NullExpression": "WorkRequest->RequesterType eq 'FreeText'" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->RequesterContact_Id", "x-NullExpression": "WorkRequest->RequesterType eq 'User'" }, "requesterContactCode": { "title": "requesterContactCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->RequesterContact_Code" }, "address": { "title": "address", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Address" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Asset_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Description" }, "email": { "title": "email", "type": "string", "format": "email", "x-nullable": true, "x-propertyPath": "WorkRequest->Email" }, "estimatedDuration": { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequest->EstimatedDuration" }, "failedComponentId": { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Id", "x-NullExpression": "WorkRequest->Asset_Id eq null" }, "failedComponentCode": { "title": "failedComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Code" }, "failedComponentDescription": { "title": "failedComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Notes" }, "phone1": { "title": "phone1", "type": "string", "format": "phone", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1" }, "phone1TypeId": { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Id" }, "phone1TypeCode": { "title": "phone1TypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Code" }, "phone1TypeDescription": { "title": "phone1TypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Description" }, "phone2": { "title": "phone2", "type": "string", "format": "phone", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2" }, "latestWorkRequestStatusChangeId": { "title": "latestWorkRequestStatusChangeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->LatestWorkRequestStatusChange_Id" }, "latestWorkRequestStatusChangeRemark": { "title": "latestWorkRequestStatusChangeRemark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->LatestWorkRequestStatusChange_Remark" }, "phone2TypeId": { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Id" }, "phone2TypeCode": { "title": "phone2TypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Code" }, "phone2TypeDescription": { "title": "phone2TypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Description" }, "priority": { "title": "priority", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->Priority", "x-formatSpecifier": "WorkRequestPriority" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequestedOn" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequiredBy" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Description" }, "responsibleStaffMemberId": { "title": "responsibleStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Id" }, "responsibleStaffMemberCode": { "title": "responsibleStaffMemberCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Code" }, "responsibleStaffMemberResourceType": { "title": "responsibleStaffMemberResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_ResourceType", "x-formatSpecifier": "ResourceType" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->Status_Id" }, "statusCode": { "title": "statusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Status_Code" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Status_Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->Status_BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Description" }, "typeOfWorkWorkType": { "title": "typeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->WorkOrder_Description" }, "workRequested": { "title": "workRequested", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkRequested" } } }, "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" } } }, "GetWorkRequestCollectionResourceActionResponse": { "title": "GetWorkRequestCollectionResourceActionResponse", "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": "GetWorkRequestCollectionResourceActionResponseItem", "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": "GetWorkRequestCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Description" }, "address": { "title": "address", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Address" }, "email": { "title": "email", "type": "string", "format": "email", "x-nullable": true, "x-propertyPath": "WorkRequest->Email" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Asset_Description" }, "estimatedDuration": { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequest->EstimatedDuration" }, "failedComponentId": { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Id" }, "failedComponentCode": { "title": "failedComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->FailedComponent_Code" }, "failedComponentDescription": { "title": "failedComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->FailedComponent_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->PermissionTree_Description" }, "priority": { "title": "priority", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->Priority", "x-formatSpecifier": "WorkRequestPriority" }, "phone1": { "title": "phone1", "type": "string", "format": "phone", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1" }, "phone1TypeId": { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Id" }, "phone1TypeCode": { "title": "phone1TypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Phone1Type_Code" }, "phone1TypeDescription": { "title": "phone1TypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Phone1Type_Description" }, "phone2": { "title": "phone2", "type": "string", "format": "phone", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2" }, "phone2TypeId": { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Id" }, "phone2TypeCode": { "title": "phone2TypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Phone2Type_Code" }, "phone2TypeDescription": { "title": "phone2TypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Phone2Type_Description" }, "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->WorkOrder_Id" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkOrder_Description" }, "workRequested": { "title": "workRequested", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkRequested" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequestedOn" }, "requester": { "title": "requester", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Requester", "x-NullExpression": "WorkRequest->RequesterType eq 'FreeText'" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequiredBy" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->ResponsibleSection_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Site_Description" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Status_Id" }, "statusCode": { "title": "statusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Status_Code" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Status_Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->Status_BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->TypeOfWork_Code" }, "responsibleStaffMemberId": { "title": "responsibleStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Id" }, "responsibleStaffMemberCode": { "title": "responsibleStaffMemberCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Code" } } }, "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" } } } }, "WorkRequestAssetLookupResourceActionResponse": { "title": "WorkRequestAssetLookupResourceActionResponse", "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": "WorkRequestAssetLookupResourceActionResponseItem", "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": "WorkRequestAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Location_Description" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": true, "x-propertyPath": "Asset->IsMsi" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Barcode" } } }, "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" } } } }, "WorkRequestChangePermissionTreeLookupResourceActionResponse": { "title": "WorkRequestChangePermissionTreeLookupResourceActionResponse", "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": "WorkRequestChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestFailedComponentLookupResourceActionResponse": { "title": "WorkRequestFailedComponentLookupResourceActionResponse", "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": "WorkRequestFailedComponentLookupResourceActionResponseItem", "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": "WorkRequestFailedComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "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" } } } }, "WorkRequestGeographicDataAssetReferenceEntityLookupResourceActionResponse": { "title": "WorkRequestGeographicDataAssetReferenceEntityLookupResourceActionResponse", "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": "WorkRequestGeographicDataAssetReferenceEntityLookupResourceActionResponseItem", "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": "WorkRequestGeographicDataAssetReferenceEntityLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "Asset->GeographicLocation" } } }, "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" } } } }, "WorkRequestGeographicUnitOfMeasurementLookupResourceActionResponse": { "title": "WorkRequestGeographicUnitOfMeasurementLookupResourceActionResponse", "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": "WorkRequestGeographicUnitOfMeasurementLookupResourceActionResponseItem", "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": "WorkRequestGeographicUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkRequestInsertPermissionTreeLookupResourceActionResponse", "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": "WorkRequestInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestPhone1TypeLookupResourceActionResponse": { "title": "WorkRequestPhone1TypeLookupResourceActionResponse", "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": "WorkRequestPhone1TypeLookupResourceActionResponseItem", "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": "WorkRequestPhone1TypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->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" } } } }, "WorkRequestPhone2TypeLookupResourceActionResponse": { "title": "WorkRequestPhone2TypeLookupResourceActionResponse", "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": "WorkRequestPhone2TypeLookupResourceActionResponseItem", "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": "WorkRequestPhone2TypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->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" } } } }, "WorkRequestRequesterContactLookupResourceActionResponse": { "title": "WorkRequestRequesterContactLookupResourceActionResponse", "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": "WorkRequestRequesterContactLookupResourceActionResponseItem", "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": "WorkRequestRequesterContactLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "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" } } } }, "WorkRequestSectionLookupResourceActionResponse": { "title": "WorkRequestSectionLookupResourceActionResponse", "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": "WorkRequestSectionLookupResourceActionResponseItem", "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": "WorkRequestSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "WorkRequestStaffMemberLookupResourceActionResponse": { "title": "WorkRequestStaffMemberLookupResourceActionResponse", "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": "WorkRequestStaffMemberLookupResourceActionResponseItem", "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": "WorkRequestStaffMemberLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "WorkRequestSiteLookupResourceActionResponse": { "title": "WorkRequestSiteLookupResourceActionResponse", "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": "WorkRequestSiteLookupResourceActionResponseItem", "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": "WorkRequestSiteLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestStatusLookupResourceActionResponse": { "title": "WorkRequestStatusLookupResourceActionResponse", "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": "WorkRequestStatusLookupResourceActionResponseItem", "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": "WorkRequestStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" } } }, "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" } } } }, "WorkRequestTypeOfWorkLookupResourceActionResponse": { "title": "WorkRequestTypeOfWorkLookupResourceActionResponse", "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": "WorkRequestTypeOfWorkLookupResourceActionResponseItem", "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": "WorkRequestTypeOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" }, "workType": { "title": "workType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkType", "x-formatSpecifier": "WorkType" } } }, "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" } } } }, "WorkRequestWorkOrderAssetLookupResourceActionResponse": { "title": "WorkRequestWorkOrderAssetLookupResourceActionResponse", "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": "WorkRequestWorkOrderAssetLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Description" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": true, "x-propertyPath": "Asset->IsMsi" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Barcode" } } }, "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" } } } }, "WorkRequestWorkOrderCostCentreLookupResourceActionResponse": { "title": "WorkRequestWorkOrderCostCentreLookupResourceActionResponse", "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": "WorkRequestWorkOrderCostCentreLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->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" } } } }, "WorkRequestWorkOrderFailedComponentLookupResourceActionResponse": { "title": "WorkRequestWorkOrderFailedComponentLookupResourceActionResponse", "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": "WorkRequestWorkOrderFailedComponentLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderFailedComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "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" } } } }, "WorkRequestWorkOrderGeneralLedgerLookupResourceActionResponse": { "title": "WorkRequestWorkOrderGeneralLedgerLookupResourceActionResponse", "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": "WorkRequestWorkOrderGeneralLedgerLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->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" } } } }, "WorkRequestWorkOrderLookupResourceActionResponse": { "title": "WorkRequestWorkOrderLookupResourceActionResponse", "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": "WorkRequestWorkOrderLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" } } }, "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" } } } }, "WorkRequestWorkOrderSectionLookupResourceActionResponse": { "title": "WorkRequestWorkOrderSectionLookupResourceActionResponse", "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": "WorkRequestWorkOrderSectionLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "WorkRequestWorkOrderSiteLookupResourceActionResponse": { "title": "WorkRequestWorkOrderSiteLookupResourceActionResponse", "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": "WorkRequestWorkOrderSiteLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderSiteLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestWorkOrderStaffMemberLookupResourceActionResponse": { "title": "WorkRequestWorkOrderStaffMemberLookupResourceActionResponse", "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": "WorkRequestWorkOrderStaffMemberLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderStaffMemberLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "WorkRequestWorkOrderTradeLookupResourceActionResponse": { "title": "WorkRequestWorkOrderTradeLookupResourceActionResponse", "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": "WorkRequestWorkOrderTradeLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->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" } } } }, "WorkRequestWorkOrderTypeOfWorkLookupResourceActionResponse": { "title": "WorkRequestWorkOrderTypeOfWorkLookupResourceActionResponse", "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": "WorkRequestWorkOrderTypeOfWorkLookupResourceActionResponseItem", "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": "WorkRequestWorkOrderTypeOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->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" } } } }, "CreateWorkRequestResourceActionRequest": { "title": "CreateWorkRequestResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkRequestResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "motionType", "permissionTreeId", "requestedOn", "requesterType", "workRequested" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "WorkRequest->Asset_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Code", "x-systemGenerated": true }, "address": { "title": "address", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Address" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Description", "x-systemGenerated": true }, "email": { "title": "email", "type": "string", "format": "email", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "WorkRequest->Email" }, "estimatedDuration": { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequest->EstimatedDuration" }, "failedComponentId": { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Id", "x-NullExpression": "WorkRequest->Asset_Id eq null" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->PermissionTree_Id" }, "phone1": { "title": "phone1", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1" }, "phone2": { "title": "phone2", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2" }, "phone1TypeId": { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Id" }, "phone2TypeId": { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Id" }, "priority": { "title": "priority", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->Priority", "x-formatSpecifier": "WorkRequestPriority" }, "requestedOn": { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequestedOn" }, "requester": { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Requester", "x-NullExpression": "WorkRequest->RequesterType eq 'FreeText'", "x-MinLengthExpression": "WorkRequest->RequesterType eq 'FreeText'" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->RequesterContact_Id", "x-NullExpression": "WorkRequest->RequesterType eq 'User'" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequiredBy" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Id" }, "responsibleStaffMemberId": { "title": "responsibleStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Id" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->Site_Id" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Id" }, "workRequested": { "title": "workRequested", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkRequested" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "WorkRequest->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkRequestResourceActionRequest": { "title": "UpdateWorkRequestResourceActionRequest", "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": "assetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "WorkRequest->Asset_Id" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Code" }, { "title": "address", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Address" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Description" }, { "title": "email", "type": "string", "format": "email", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "WorkRequest->Email" }, { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequest->EstimatedDuration" }, { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Id", "x-NullExpression": "WorkRequest->Asset_Id eq null" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Notes" }, { "title": "phone1", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1" }, { "title": "phone2", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2" }, { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Id" }, { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Id" }, { "title": "priority", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->Priority", "x-formatSpecifier": "WorkRequestPriority" }, { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequestedOn" }, { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Requester", "x-NullExpression": "WorkRequest->RequesterType eq 'FreeText'", "x-MinLengthExpression": "WorkRequest->RequesterType eq 'FreeText'" }, { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->RequesterContact_Id", "x-NullExpression": "WorkRequest->RequesterType eq 'User'" }, { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequiredBy" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Id" }, { "title": "responsibleStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Id" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->Site_Id" }, { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->WorkOrder_Id" }, { "title": "workRequested", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkRequested" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Id" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityId" } ] } } }, "BatchGetWorkRequestResourceAction": { "title": "BatchGetWorkRequestResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request entities", "items": { "$ref": "#/definitions/GetWorkRequestResourceActionResponse" } }, "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" } } }, "BatchCreateWorkRequestResourceActionRequest": { "title": "BatchCreateWorkRequestResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkRequestResourceActionRequest" } }, "BatchUpdateWorkRequestResourceActionRequest": { "title": "BatchUpdateWorkRequestResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkRequestResourceActionRequest" } }, "ChangeWorkRequestPermissionTreeResourceActionRequest": { "title": "ChangeWorkRequestPermissionTreeResourceActionRequest", "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": "WorkRequest->PermissionTree_Id" } ] } } }, "CreateWorkOrderForWorkRequestsResourceActionRequest": { "title": "CreateWorkOrderForWorkRequestsResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkOrderForWorkRequestsResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workRequestIds" ], "properties": { "workRequestIds": { "title": "workRequestIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "CreateWorkOrderForWorkRequests->WorkRequestIds", "x-formatSpecifier": "Int64" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->Site_Id" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->Asset_Id" }, "estimatedDuration": { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "CreateWorkOrderForWorkRequests->EstimatedDuration" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->MotionType", "x-formatSpecifier": "MotionType" }, "requester": { "title": "requester", "type": "string", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->Requester" }, "requesterContactId": { "title": "requesterContactId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->RequesterContact_Id" }, "requesterType": { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CreateWorkOrderForWorkRequests->RequiredBy" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->Section_Id" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->StaffMember_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->Trade_Id" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->TypeOfWork_Id" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->GeneralLedger_Id" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->CostCentre_Id" }, "failedComponentId": { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateWorkOrderForWorkRequests->FailedComponent_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "LinkWorkOrderToWorkRequestsResourceActionRequest": { "title": "LinkWorkOrderToWorkRequestsResourceActionRequest", "type": "object", "properties": { "properties": { "title": "LinkWorkOrderToWorkRequestsResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderId", "workRequestIds" ], "properties": { "workOrderId": { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LinkWorkOrderToWorkRequests->WorkOrderId" }, "workRequestIds": { "title": "workRequestIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "LinkWorkOrderToWorkRequests->WorkRequestIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeWorkRequestStatusResourceActionRequest": { "title": "ChangeWorkRequestStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ChangeWorkRequestStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workRequestId", "statusId" ], "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChange->WorkRequest_Id" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChange->Status_Id" }, "statusChangedOn": { "title": "statusChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatusChange->StatusChangedOn" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChange->Remark" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeWorkRequestStatusResourceActionRequest": { "title": "BatchChangeWorkRequestStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestStatusResourceActionRequest" } }, "BatchChangeWorkRequestPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkRequestPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestPermissionTreeResourceActionRequest" } }, "MatchUpdateWorkRequestResourceActionRequest": { "title": "MatchUpdateWorkRequestResourceActionRequest", "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": "assetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "WorkRequest->Asset_Id" }, { "title": "address", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Address" }, { "title": "email", "type": "string", "format": "email", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "WorkRequest->Email" }, { "title": "estimatedDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequest->EstimatedDuration" }, { "title": "failedComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->FailedComponent_Id", "x-NullExpression": "WorkRequest->Asset_Id eq null" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->Notes" }, { "title": "phone1", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1" }, { "title": "phone2", "type": "string", "format": "phone", "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2" }, { "title": "phone1TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone1Type_Id" }, { "title": "phone2TypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->Phone2Type_Id" }, { "title": "priority", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequest->Priority", "x-formatSpecifier": "WorkRequestPriority" }, { "title": "requestedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequestedOn" }, { "title": "requester", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequest->Requester", "x-NullExpression": "WorkRequest->RequesterType eq 'FreeText'", "x-MinLengthExpression": "WorkRequest->RequesterType eq 'FreeText'" }, { "title": "requesterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->RequesterType", "x-formatSpecifier": "WorkRequesterType" }, { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequest->RequiredBy" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleSection_Id" }, { "title": "responsibleStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->ResponsibleStaffMember_Id" }, { "title": "workOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->WorkOrder_Id" }, { "title": "workRequested", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->WorkRequested" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->TypeOfWork_Id" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequest->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequest->GeographicReferenceEntityId" } ] } } }, "GetWorkRequestAttributeResourceActionResponse": { "title": "GetWorkRequestAttributeResourceActionResponse", "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": "GetWorkRequestAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Description" }, "workRequestStatusId": { "title": "workRequestStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Status_Id" }, "workRequestStatusBaseStatus": { "title": "workRequestStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Status_BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->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" } } }, "GetWorkRequestAttributeCollectionForWorkRequestResourceActionResponse": { "title": "GetWorkRequestAttributeCollectionForWorkRequestResourceActionResponse", "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": "GetWorkRequestAttributeCollectionForWorkRequestResourceActionResponseItem", "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": "GetWorkRequestAttributeCollectionForWorkRequestResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestAttribute->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" } } } }, "GetWorkRequestAttributeCollectionResourceActionResponse": { "title": "GetWorkRequestAttributeCollectionResourceActionResponse", "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": "GetWorkRequestAttributeCollectionResourceActionResponseItem", "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": "GetWorkRequestAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Description" }, "workRequestStatusBaseStatus": { "title": "workRequestStatusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Status_BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestAttribute->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" } } } }, "WorkRequestAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "WorkRequestAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "WorkRequestAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "WorkRequestAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestAttributeAttributeLookupResourceActionResponse": { "title": "WorkRequestAttributeAttributeLookupResourceActionResponse", "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": "WorkRequestAttributeAttributeLookupResourceActionResponseItem", "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": "WorkRequestAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "WorkRequestAttributeChangePermissionTreeLookupResourceActionResponse", "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": "WorkRequestAttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkRequestAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "WorkRequestAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestAttributeWorkRequestLookupResourceActionResponse": { "title": "WorkRequestAttributeWorkRequestLookupResourceActionResponse", "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": "WorkRequestAttributeWorkRequestLookupResourceActionResponseItem", "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": "WorkRequestAttributeWorkRequestLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->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" } } } }, "CreateWorkRequestAttributeResourceActionRequest": { "title": "CreateWorkRequestAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkRequestAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workRequestId", "attributeId" ], "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->WorkRequest_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "WorkRequestAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkRequestAttributeResourceActionRequest": { "title": "UpdateWorkRequestAttributeResourceActionRequest", "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": "WorkRequestAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestAttribute->Notes" } ] } } }, "DeleteWorkRequestAttributeResourceActionRequest": { "title": "DeleteWorkRequestAttributeResourceActionRequest", "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 } } }, "BatchGetWorkRequestAttributeResourceAction": { "title": "BatchGetWorkRequestAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request Attribute entities", "items": { "$ref": "#/definitions/GetWorkRequestAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateWorkRequestAttributeResourceActionRequest": { "title": "BatchCreateWorkRequestAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkRequestAttributeResourceActionRequest" } }, "BatchUpdateWorkRequestAttributeResourceActionRequest": { "title": "BatchUpdateWorkRequestAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkRequestAttributeResourceActionRequest" } }, "BatchDeleteWorkRequestAttributeResourceActionRequest": { "title": "BatchDeleteWorkRequestAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkRequestAttributeResourceActionRequest" } }, "ChangeWorkRequestAttributeIsActiveResourceActionRequest": { "title": "ChangeWorkRequestAttributeIsActiveResourceActionRequest", "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": "WorkRequestAttribute->IsActive" } ] } } }, "ChangeWorkRequestAttributePermissionTreeResourceActionRequest": { "title": "ChangeWorkRequestAttributePermissionTreeResourceActionRequest", "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": "WorkRequestAttribute->PermissionTree_Id" } ] } } }, "BatchChangeWorkRequestAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeWorkRequestAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestAttributePermissionTreeResourceActionRequest" } }, "BatchChangeWorkRequestAttributeIsActiveResourceActionRequest": { "title": "BatchChangeWorkRequestAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestAttributeIsActiveResourceActionRequest" } }, "GetWorkRequestDocumentResourceActionResponse": { "title": "GetWorkRequestDocumentResourceActionResponse", "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": "GetWorkRequestDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->WorkRequest_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->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" } } }, "GetWorkRequestDocumentCollectionForWorkRequestResourceActionResponse": { "title": "GetWorkRequestDocumentCollectionForWorkRequestResourceActionResponse", "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": "GetWorkRequestDocumentCollectionForWorkRequestResourceActionResponseItem", "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": "GetWorkRequestDocumentCollectionForWorkRequestResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->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" } } } }, "GetWorkRequestDocumentCollectionResourceActionResponse": { "title": "GetWorkRequestDocumentCollectionResourceActionResponse", "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": "GetWorkRequestDocumentCollectionResourceActionResponseItem", "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": "GetWorkRequestDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->WorkRequest_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->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" } } } }, "WorkRequestDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "WorkRequestDocumentChangePermissionTreeLookupResourceActionResponse", "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": "WorkRequestDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestDocumentDocumentLookupResourceActionResponse": { "title": "WorkRequestDocumentDocumentLookupResourceActionResponse", "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": "WorkRequestDocumentDocumentLookupResourceActionResponseItem", "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": "WorkRequestDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkRequestDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "WorkRequestDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestDocumentWorkRequestLookupResourceActionResponse": { "title": "WorkRequestDocumentWorkRequestLookupResourceActionResponse", "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": "WorkRequestDocumentWorkRequestLookupResourceActionResponseItem", "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": "WorkRequestDocumentWorkRequestLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequest->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" } } } }, "CreateWorkRequestDocumentResourceActionRequest": { "title": "CreateWorkRequestDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkRequestDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workRequestId", "documentRecordId" ], "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->WorkRequest_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkRequestDocumentResourceActionRequest": { "title": "UpdateWorkRequestDocumentResourceActionRequest", "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": "WorkRequestDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestDocument->Notes" } ] } } }, "DeleteWorkRequestDocumentResourceActionRequest": { "title": "DeleteWorkRequestDocumentResourceActionRequest", "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 } } }, "BatchGetWorkRequestDocumentResourceAction": { "title": "BatchGetWorkRequestDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request Document entities", "items": { "$ref": "#/definitions/GetWorkRequestDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateWorkRequestDocumentResourceActionRequest": { "title": "BatchCreateWorkRequestDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkRequestDocumentResourceActionRequest" } }, "BatchUpdateWorkRequestDocumentResourceActionRequest": { "title": "BatchUpdateWorkRequestDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkRequestDocumentResourceActionRequest" } }, "BatchDeleteWorkRequestDocumentResourceActionRequest": { "title": "BatchDeleteWorkRequestDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkRequestDocumentResourceActionRequest" } }, "ChangeWorkRequestDocumentIsActiveResourceActionRequest": { "title": "ChangeWorkRequestDocumentIsActiveResourceActionRequest", "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": "WorkRequestDocument->IsActive" } ] } } }, "ChangeWorkRequestDocumentPermissionTreeResourceActionRequest": { "title": "ChangeWorkRequestDocumentPermissionTreeResourceActionRequest", "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": "WorkRequestDocument->PermissionTree_Id" } ] } } }, "BatchChangeWorkRequestDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkRequestDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeWorkRequestDocumentIsActiveResourceActionRequest": { "title": "BatchChangeWorkRequestDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestDocumentIsActiveResourceActionRequest" } }, "GetWorkRequestFileAttachmentResourceActionResponse": { "title": "GetWorkRequestFileAttachmentResourceActionResponse", "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": "GetWorkRequestFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "WorkRequestFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_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" } } }, "GetWorkRequestFileAttachmentCollectionForWorkRequestResourceActionResponse": { "title": "GetWorkRequestFileAttachmentCollectionForWorkRequestResourceActionResponse", "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": "GetWorkRequestFileAttachmentCollectionForWorkRequestResourceActionResponseItem", "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": "GetWorkRequestFileAttachmentCollectionForWorkRequestResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestFileAttachment->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" } } } }, "GetWorkRequestFileAttachmentCollectionResourceActionResponse": { "title": "GetWorkRequestFileAttachmentCollectionResourceActionResponse", "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": "GetWorkRequestFileAttachmentCollectionResourceActionResponseItem", "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": "GetWorkRequestFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestFileAttachment->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" } } } }, "CreateWorkRequestFileAttachmentResourceActionRequest": { "title": "CreateWorkRequestFileAttachmentResourceActionRequest", "type": "object", "required": [ "workRequestId" ], "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkRequestFileAttachmentContentResourceActionRequest": { "title": "UpdateWorkRequestFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateWorkRequestFileAttachmentResourceActionRequest": { "title": "UpdateWorkRequestFileAttachmentResourceActionRequest", "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": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsRestricted" } ] } } }, "DeleteWorkRequestFileAttachmentResourceResourceActionRequest": { "title": "DeleteWorkRequestFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetWorkRequestFileAttachmentResourceAction": { "title": "BatchGetWorkRequestFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request File Attachment entities", "items": { "$ref": "#/definitions/GetWorkRequestFileAttachmentResourceActionResponse" } }, "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" } } }, "GetWorkRequestFileAttachmentContentHistoryResourceActionResponse": { "title": "GetWorkRequestFileAttachmentContentHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetWorkRequestFileAttachmentContentHistoryResourceAction": { "title": "GetWorkRequestFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request File Attachment entities", "items": { "$ref": "#/definitions/GetWorkRequestFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateWorkRequestFileAttachmentResourceActionRequest": { "title": "BatchCreateWorkRequestFileAttachmentResourceActionRequest", "type": "object", "required": [ "workRequestId" ], "properties": { "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->WorkRequest_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateWorkRequestFileAttachmentResourceActionRequest": { "title": "BatchUpdateWorkRequestFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkRequestFileAttachmentResourceActionRequest" } }, "BatchDeleteWorkRequestFileAttachmentResourceActionRequest": { "title": "BatchDeleteWorkRequestFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkRequestFileAttachmentResourceResourceActionRequest" } }, "GetWorkRequestStatusResourceActionResponse": { "title": "GetWorkRequestStatusResourceActionResponse", "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": "GetWorkRequestStatusResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatus->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatus->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" } } }, "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" } } }, "GetWorkRequestStatusCollectionResourceActionResponse": { "title": "GetWorkRequestStatusCollectionResourceActionResponse", "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": "GetWorkRequestStatusCollectionResourceActionResponseItem", "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": "GetWorkRequestStatusCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->IsActive" } } }, "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" } } } }, "WorkRequestStatusChangePermissionTreeLookupResourceActionResponse": { "title": "WorkRequestStatusChangePermissionTreeLookupResourceActionResponse", "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": "WorkRequestStatusChangePermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestStatusChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WorkRequestStatusInsertPermissionTreeLookupResourceActionResponse": { "title": "WorkRequestStatusInsertPermissionTreeLookupResourceActionResponse", "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": "WorkRequestStatusInsertPermissionTreeLookupResourceActionResponseItem", "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": "WorkRequestStatusInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateWorkRequestStatusResourceActionRequest": { "title": "CreateWorkRequestStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWorkRequestStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "baseStatus" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->SequenceNumber" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkRequestStatus->BaseStatus", "x-formatSpecifier": "WorkRequestStatusBaseStatus" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWorkRequestStatusResourceActionRequest": { "title": "UpdateWorkRequestStatusResourceActionRequest", "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": "WorkRequestStatus->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WorkRequestStatus->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatus->Notes" } ] } } }, "DeleteWorkRequestStatusResourceActionRequest": { "title": "DeleteWorkRequestStatusResourceActionRequest", "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 } } }, "BatchGetWorkRequestStatusResourceAction": { "title": "BatchGetWorkRequestStatusResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request Status entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request Status entities", "items": { "$ref": "#/definitions/GetWorkRequestStatusResourceActionResponse" } }, "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" } } }, "BatchCreateWorkRequestStatusResourceActionRequest": { "title": "BatchCreateWorkRequestStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWorkRequestStatusResourceActionRequest" } }, "BatchUpdateWorkRequestStatusResourceActionRequest": { "title": "BatchUpdateWorkRequestStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWorkRequestStatusResourceActionRequest" } }, "BatchDeleteWorkRequestStatusResourceActionRequest": { "title": "BatchDeleteWorkRequestStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWorkRequestStatusResourceActionRequest" } }, "ChangeWorkRequestStatusIsActiveResourceActionRequest": { "title": "ChangeWorkRequestStatusIsActiveResourceActionRequest", "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": "WorkRequestStatus->IsActive" } ] } } }, "ChangeWorkRequestStatusPermissionTreeResourceActionRequest": { "title": "ChangeWorkRequestStatusPermissionTreeResourceActionRequest", "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": "WorkRequestStatus->PermissionTree_Id" } ] } } }, "BatchChangeWorkRequestStatusIsActiveResourceActionRequest": { "title": "BatchChangeWorkRequestStatusIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestStatusIsActiveResourceActionRequest" } }, "BatchChangeWorkRequestStatusPermissionTreeResourceActionRequest": { "title": "BatchChangeWorkRequestStatusPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWorkRequestStatusPermissionTreeResourceActionRequest" } }, "GetWorkRequestStatusChangeHistoryResourceActionResponse": { "title": "GetWorkRequestStatusChangeHistoryResourceActionResponse", "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": "GetWorkRequestStatusChangeHistoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedOn" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequestStatusChangeHistory->ElapsedTime" }, "statusChangedOn": { "title": "statusChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatusChangeHistory->StatusChangedOn" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_Id" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->Remark" }, "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Description" }, "workRequestWorkRequested": { "title": "workRequestWorkRequested", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_WorkRequested" } } }, "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" } } }, "GetWorkRequestStatusChangeHistoryCollectionResourceActionResponse": { "title": "GetWorkRequestStatusChangeHistoryCollectionResourceActionResponse", "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": "GetWorkRequestStatusChangeHistoryCollectionResourceActionResponseItem", "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": "GetWorkRequestStatusChangeHistoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequestStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_Id" }, "predecessorWorkRequestCode": { "title": "predecessorWorkRequestCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Code" }, "predecessorWorkRequestDescription": { "title": "predecessorWorkRequestDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Description" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->Remark" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedByUser_Code" }, "workRequestId": { "title": "workRequestId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Id" }, "workRequestCode": { "title": "workRequestCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Code" }, "workRequestDescription": { "title": "workRequestDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Description" }, "workRequestPermissionTreeCode": { "title": "workRequestPermissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_PermissionTree_Code" }, "workRequestPermissionTreeDescription": { "title": "workRequestPermissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_PermissionTree_Description" }, "workRequestSiteCode": { "title": "workRequestSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_Site_Code" }, "workRequestSiteDescription": { "title": "workRequestSiteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->WorkRequest_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" } } } }, "GetWorkRequestStatusChangeHistoryCollectionForWorkRequestResourceActionResponse": { "title": "GetWorkRequestStatusChangeHistoryCollectionForWorkRequestResourceActionResponse", "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": "GetWorkRequestStatusChangeHistoryCollectionForWorkRequestResourceActionResponseItem", "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": "GetWorkRequestStatusChangeHistoryCollectionForWorkRequestResourceActionResponseItemProperties", "type": "object", "properties": { "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "WorkRequestStatusChangeHistory->ElapsedTime" }, "isLatest": { "title": "isLatest", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->IsLatest" }, "newStatusId": { "title": "newStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Id" }, "newStatusCode": { "title": "newStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Code" }, "newStatusDescription": { "title": "newStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->NewStatus_Description" }, "oldStatusId": { "title": "oldStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Id" }, "oldStatusCode": { "title": "oldStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Code" }, "oldStatusDescription": { "title": "oldStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->OldStatus_Description" }, "predecessorId": { "title": "predecessorId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_Id" }, "predecessorWorkRequestCode": { "title": "predecessorWorkRequestCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Code" }, "predecessorWorkRequestDescription": { "title": "predecessorWorkRequestDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->Predecessor_WorkRequest_Description" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "WorkRequestStatusChangeHistory->Remark" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedOn" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkRequestStatusChangeHistory->CreatedByUser_Code" } } }, "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" } } } }, "BatchGetWorkRequestStatusChangeHistoryResourceAction": { "title": "BatchGetWorkRequestStatusChangeHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Work Request Status Change History entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Work Request Status Change History entities", "items": { "$ref": "#/definitions/GetWorkRequestStatusChangeHistoryResourceActionResponse" } }, "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" } } } }, "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": "Due Task" }, { "name": "Due Task Suppressor" }, { "name": "Proposed Work Order" }, { "name": "Proposed Work Order Meter" }, { "name": "Proposed Work Order Task" }, { "name": "Service Level Agreement" }, { "name": "Service Level Agreement Classification" }, { "name": "Service Level Agreement Measure" }, { "name": "Service Level Agreement Measure Field Assignment" }, { "name": "Service Level Agreement Measure Trigger" }, { "name": "Work Order" }, { "name": "Work Order Attribute" }, { "name": "Work Order Complete All Tasks Log" }, { "name": "Work Order Document" }, { "name": "Work Order Downtime Loss" }, { "name": "Work Order File Attachment" }, { "name": "Work Order Importance" }, { "name": "Work Order Meter" }, { "name": "Work Order Monitoring Point" }, { "name": "Work Order Movement" }, { "name": "Work Order Progress Event" }, { "name": "Work Order Progress Event Allowed Change" }, { "name": "Work Order Progress Log" }, { "name": "Work Order Service Level Agreement" }, { "name": "Work Order Service Level Agreement Measure" }, { "name": "Work Order Status" }, { "name": "Work Order Status Allowed Change" }, { "name": "Work Order Status Attribute" }, { "name": "Work Order Status Change History" }, { "name": "Work Order Status Document" }, { "name": "Work Order Task" }, { "name": "Work Order Task Ad Hoc Cost" }, { "name": "Work Order Task Document" }, { "name": "Work Order Task File Attachment" }, { "name": "Work Order Task Monitoring Point" }, { "name": "Work Order Task Movement" }, { "name": "Work Order Task Resource" }, { "name": "Work Order Task Resource Movement" }, { "name": "Work Order Task Resource Usage" }, { "name": "Work Order Task Spare" }, { "name": "Work Order Task Spare File Attachment" }, { "name": "Work Order Task Spare Movement" }, { "name": "Work Order Task Sub Task" }, { "name": "Work Order Task Sub Task Movement" }, { "name": "Work Order Task Warranty" }, { "name": "Work Order Warranty" }, { "name": "Work Request" }, { "name": "Work Request Attribute" }, { "name": "Work Request Document" }, { "name": "Work Request File Attachment" }, { "name": "Work Request Status" }, { "name": "Work Request Status Change History" } ], "x-tagGroups": [ { "name": "WM", "tags": [ "Due Task", "Due Task Suppressor", "Proposed Work Order", "Proposed Work Order Meter", "Proposed Work Order Task", "Service Level Agreement", "Service Level Agreement Classification", "Service Level Agreement Measure", "Service Level Agreement Measure Field Assignment", "Service Level Agreement Measure Trigger", "Work Order", "Work Order Attribute", "Work Order Complete All Tasks Log", "Work Order Document", "Work Order Downtime Loss", "Work Order File Attachment", "Work Order Importance", "Work Order Meter", "Work Order Monitoring Point", "Work Order Movement", "Work Order Progress Event", "Work Order Progress Event Allowed Change", "Work Order Progress Log", "Work Order Service Level Agreement", "Work Order Service Level Agreement Measure", "Work Order Status", "Work Order Status Allowed Change", "Work Order Status Attribute", "Work Order Status Change History", "Work Order Status Document", "Work Order Task", "Work Order Task Ad Hoc Cost", "Work Order Task Document", "Work Order Task File Attachment", "Work Order Task Monitoring Point", "Work Order Task Movement", "Work Order Task Resource", "Work Order Task Resource Movement", "Work Order Task Resource Usage", "Work Order Task Spare", "Work Order Task Spare File Attachment", "Work Order Task Spare Movement", "Work Order Task Sub Task", "Work Order Task Sub Task Movement", "Work Order Task Warranty", "Work Order Warranty", "Work Request", "Work Request Attribute", "Work Request Document", "Work Request File Attachment", "Work Request Status", "Work Request Status Change History" ] } ] }