{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key SYSTEM 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.entitycollection+json", "application/vnd.onkey.entityexistscheckcollection+json", "multipart/form-data", "text/csv", "application/vnd.onkey.entityimportcollection+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entityexistscheckresultcollection+json", "text/csv", "application/vnd.onkey.licence+lic", "application/vnd.onkey.licencerequest+qlic" ], "paths": { "/Modules/SYSTEM/BackgroundTasks/{id}": { "get": { "tags": [ "Background Task" ], "summary": "Get a Background 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 | BackgroundTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BackgroundTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BackgroundTask->CreatedByUser_FullName | string | |\r\n| createdOn | BackgroundTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | BackgroundTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BackgroundTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BackgroundTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BackgroundTask->ModifiedOn | string | date-time |\r\n| version | BackgroundTask->Version | integer | int32 |\r\n| id | BackgroundTask->Id | integer | int64 |\r\n| alerted | BackgroundTask->Alerted | boolean | |\r\n| averageTimePerStep | BackgroundTask->AverageTimePerStep | string | duration |\r\n| completedOn | BackgroundTask->CompletedOn | string | date-time |\r\n| completedSteps | BackgroundTask->CompletedSteps | integer | int32 |\r\n| elapsedTime | BackgroundTask->ElapsedTime | string | duration |\r\n| estimatedCompletion | BackgroundTask->EstimatedCompletion | string | date-time |\r\n| estimatedTimeRemaining | BackgroundTask->EstimatedTimeRemaining | string | duration |\r\n| failedSteps | BackgroundTask->FailedSteps | integer | int32 |\r\n| name | BackgroundTask->Name | string | |\r\n| origin | BackgroundTask->Origin | string (Allowed values: [User, Job]) | enum |\r\n| priority | BackgroundTask->Priority | integer | int32 |\r\n| remainingSteps | BackgroundTask->RemainingSteps | integer | int32 |\r\n| skippedSteps | BackgroundTask->SkippedSteps | integer | int32 |\r\n| startedOn | BackgroundTask->StartedOn | string | date-time |\r\n| status | BackgroundTask->Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| totalSteps | BackgroundTask->TotalSteps | integer | int32 |\r\n| trace | BackgroundTask->Trace | object | |\r\n| type | BackgroundTask->Type | string | |\r\n", "operationId": "GetBackgroundTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Background Task", "schema": { "$ref": "#/definitions/GetBackgroundTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Background Task" ], "summary": "Delete an existing Background 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 | BackgroundTask->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": "DeleteBackgroundTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteBackgroundTaskResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Background Task was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/{id}/Errors": { "get": { "tags": [ "Background Task" ], "summary": "Get a collection of Background Task Error resources for the Background 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 | BackgroundTaskError->Id | integer | int64 |\r\n| code | BackgroundTaskError->Code | string | |\r\n| completedOn | BackgroundTaskError->CompletedOn | string | date-time |\r\n| objectType | BackgroundTaskError->ObjectType | 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| message | BackgroundTaskError->Message | string | memo |\r\n| type | BackgroundTaskError->Type | string | |\r\n| objectId | BackgroundTaskError->ObjectId | integer | int64 |\r\n| sequenceNumber | BackgroundTaskError->SequenceNumber | integer | int32 |\r\n| severity | BackgroundTaskError->Severity | string | |\r\n| startedOn | BackgroundTaskError->StartedOn | string | date-time |\r\n| createdByUserId | BackgroundTaskError->CreatedByUserId | integer | int64 |\r\n", "operationId": "GetBackgroundTaskErrorList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task Id", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Background Task collection", "schema": { "$ref": "#/definitions/GetBackgroundTaskErrorListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks": { "get": { "tags": [ "Background Task" ], "summary": "Get a collection of Background 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 | BackgroundTask->Id | integer | int64 |\r\n| name | BackgroundTask->Name | string | |\r\n| type | BackgroundTask->Type | string | |\r\n| priority | BackgroundTask->Priority | integer | int32 |\r\n| origin | BackgroundTask->Origin | string (Allowed values: [User, Job]) | enum |\r\n| status | BackgroundTask->Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| alerted | BackgroundTask->Alerted | boolean | |\r\n| createdOn | BackgroundTask->CreatedOn | string | date-time |\r\n| modifiedOn | BackgroundTask->ModifiedOn | string | date-time |\r\n| startedOn | BackgroundTask->StartedOn | string | date-time |\r\n| completedOn | BackgroundTask->CompletedOn | string | date-time |\r\n| totalSteps | BackgroundTask->TotalSteps | integer | int32 |\r\n| failedSteps | BackgroundTask->FailedSteps | integer | int32 |\r\n| completedSteps | BackgroundTask->CompletedSteps | integer | int32 |\r\n| remainingSteps | BackgroundTask->RemainingSteps | integer | int32 |\r\n| skippedSteps | BackgroundTask->SkippedSteps | integer | int32 |\r\n| elapsedTime | BackgroundTask->ElapsedTime | string | duration |\r\n| averageTimePerStep | BackgroundTask->AverageTimePerStep | string | duration |\r\n| estimatedTimeRemaining | BackgroundTask->EstimatedTimeRemaining | string | duration |\r\n| estimatedCompletion | BackgroundTask->EstimatedCompletion | string | date-time |\r\n| version | BackgroundTask->Version | integer | int32 |\r\n", "operationId": "GetBackgroundTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Background Task collection", "schema": { "$ref": "#/definitions/GetBackgroundTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/{backgroundTaskId}/Steps": { "get": { "tags": [ "Background Task" ], "summary": "Get a collection of Background Task Step resources for the Background 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 | BackgroundTaskStep->Id | integer | int64 |\r\n| name | BackgroundTaskStep->Name | string | |\r\n| backgroundTaskId | BackgroundTaskStep->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | BackgroundTaskStep->BackgroundTask_Name | string | |\r\n| backgroundTaskType | BackgroundTaskStep->BackgroundTask_Type | string | |\r\n| backgroundTaskStatus | BackgroundTaskStep->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskOrigin | BackgroundTaskStep->BackgroundTask_Origin | string (Allowed values: [User, Job]) | enum |\r\n| createdOn | BackgroundTaskStep->CreatedOn | string | date-time |\r\n| modifiedOn | BackgroundTaskStep->ModifiedOn | string | date-time |\r\n| startedOn | BackgroundTaskStep->StartedOn | string | date-time |\r\n| completedOn | BackgroundTaskStep->CompletedOn | string | date-time |\r\n| sequenceNumber | BackgroundTaskStep->SequenceNumber | integer | int32 |\r\n| response | BackgroundTaskStep->Response | object | |\r\n| isValid | BackgroundTaskStep->IsValid | boolean | |\r\n", "operationId": "GetBackgroundTaskStepForBackgroundTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "backgroundTaskId", "in": "path", "required": true, "description": "Background 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 Background Task collection", "schema": { "$ref": "#/definitions/GetBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/Batch/{ids}": { "get": { "tags": [ "Background Task" ], "summary": "Get a collection of Background 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 | BackgroundTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BackgroundTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BackgroundTask->CreatedByUser_FullName | string | |\r\n| createdOn | BackgroundTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | BackgroundTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BackgroundTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BackgroundTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BackgroundTask->ModifiedOn | string | date-time |\r\n| version | BackgroundTask->Version | integer | int32 |\r\n| id | BackgroundTask->Id | integer | int64 |\r\n| alerted | BackgroundTask->Alerted | boolean | |\r\n| averageTimePerStep | BackgroundTask->AverageTimePerStep | string | duration |\r\n| completedOn | BackgroundTask->CompletedOn | string | date-time |\r\n| completedSteps | BackgroundTask->CompletedSteps | integer | int32 |\r\n| elapsedTime | BackgroundTask->ElapsedTime | string | duration |\r\n| estimatedCompletion | BackgroundTask->EstimatedCompletion | string | date-time |\r\n| estimatedTimeRemaining | BackgroundTask->EstimatedTimeRemaining | string | duration |\r\n| failedSteps | BackgroundTask->FailedSteps | integer | int32 |\r\n| name | BackgroundTask->Name | string | |\r\n| origin | BackgroundTask->Origin | string (Allowed values: [User, Job]) | enum |\r\n| priority | BackgroundTask->Priority | integer | int32 |\r\n| remainingSteps | BackgroundTask->RemainingSteps | integer | int32 |\r\n| skippedSteps | BackgroundTask->SkippedSteps | integer | int32 |\r\n| startedOn | BackgroundTask->StartedOn | string | date-time |\r\n| status | BackgroundTask->Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| totalSteps | BackgroundTask->TotalSteps | integer | int32 |\r\n| trace | BackgroundTask->Trace | object | |\r\n| type | BackgroundTask->Type | string | |\r\n", "operationId": "BatchGetBackgroundTask", "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 Background 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 Background Task collection", "schema": { "$ref": "#/definitions/BatchGetBackgroundTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/Batch": { "delete": { "tags": [ "Background Task" ], "summary": "Delete a collection of existing Background 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 | BackgroundTask->Id | integer | int64 |\r\n| version | BackgroundTask->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": "BatchDeleteBackgroundTask", "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/BatchDeleteBackgroundTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Background 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/SYSTEM/BackgroundTasks/Batch/{ids}/Cancel": { "post": { "tags": [ "Background Task" ], "summary": "Cancel the work registered for the collection of Background Task resources.", "description": "", "operationId": "BatchCancelBackgroundTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Background Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" } ], "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/SYSTEM/BackgroundTasks/CreateLoad/Bulk": { "post": { "tags": [ "Background Task" ], "summary": "Bulk create Background Task load.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| injectDomainEventFaults | BulkCreateBackgroundTaskLoad->InjectDomainEventFaults | boolean | |\r\n| injectFaults | BulkCreateBackgroundTaskLoad->InjectFaults | boolean | |\r\n| loadInterval | BulkCreateBackgroundTaskLoad->LoadInterval | string | duration |\r\n| maximumDelay | BulkCreateBackgroundTaskLoad->MaximumDelay | string | duration |\r\n| maximumPriority | BulkCreateBackgroundTaskLoad->MaximumPriority | integer | int32 |\r\n| maximumStepCount | BulkCreateBackgroundTaskLoad->MaximumStepCount | integer | int32 |\r\n| minimumDelay | BulkCreateBackgroundTaskLoad->MinimumDelay | string | duration |\r\n| minimumPriority | BulkCreateBackgroundTaskLoad->MinimumPriority | integer | int32 |\r\n| minimumStepCount | BulkCreateBackgroundTaskLoad->MinimumStepCount | integer | int32 |\r\n| randomUsers | BulkCreateBackgroundTaskLoad->RandomUsers | boolean | |\r\n| simulateChangeDataSubscriptions | BulkCreateBackgroundTaskLoad->SimulateChangeDataSubscriptions | boolean | |\r\n| simulateChangeDataTriggers | BulkCreateBackgroundTaskLoad->SimulateChangeDataTriggers | boolean | |\r\n| simulateChangeLog | BulkCreateBackgroundTaskLoad->SimulateChangeLog | boolean | |\r\n| simulateDomainEvents | BulkCreateBackgroundTaskLoad->SimulateDomainEvents | boolean | |\r\n| taskCount | BulkCreateBackgroundTaskLoad->TaskCount | integer | int32 |\r\n| userCount | BulkCreateBackgroundTaskLoad->UserCount | 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\r\n", "operationId": "BulkCreateBackgroundTaskLoad", "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/BulkCreateBackgroundTaskLoadResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/{id}/Cancel": { "post": { "tags": [ "Background Task" ], "summary": "Cancel the work registered for the Background Task resource.", "description": "", "operationId": "CancelBackgroundTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" } ], "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/SYSTEM/BackgroundTasks/CreateLoad": { "post": { "tags": [ "Background Task" ], "summary": "Create Background Task load.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| injectDomainEventFaults | CreateBackgroundTaskLoad->InjectDomainEventFaults | boolean | |\r\n| injectFaults | CreateBackgroundTaskLoad->InjectFaults | boolean | |\r\n| maximumDelay | CreateBackgroundTaskLoad->MaximumDelay | string | duration |\r\n| minimumDelay | CreateBackgroundTaskLoad->MinimumDelay | string | duration |\r\n| origin | CreateBackgroundTaskLoad->Origin | string (Allowed values: [User, Job]) | enum |\r\n| priority | CreateBackgroundTaskLoad->Priority | integer | int32 |\r\n| simulateChangeDataSubscriptions | CreateBackgroundTaskLoad->SimulateChangeDataSubscriptions | boolean | |\r\n| simulateChangeDataTriggers | CreateBackgroundTaskLoad->SimulateChangeDataTriggers | boolean | |\r\n| simulateChangeLog | CreateBackgroundTaskLoad->SimulateChangeLog | boolean | |\r\n| simulateDomainEvents | CreateBackgroundTaskLoad->SimulateDomainEvents | boolean | |\r\n| stepCount | CreateBackgroundTaskLoad->StepCount | integer | int64 |\r\n| taskName | CreateBackgroundTaskLoad->TaskName | string | |\r\n| userId | CreateBackgroundTaskLoad->UserId | 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": "CreateBackgroundTaskLoad", "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/CreateBackgroundTaskLoadResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/Steps/{id}": { "get": { "tags": [ "Background Task Step" ], "summary": "Get a Background Task Step 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 | BackgroundTaskStep->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BackgroundTaskStep->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BackgroundTaskStep->CreatedByUser_FullName | string | |\r\n| createdOn | BackgroundTaskStep->CreatedOn | string | date-time |\r\n| modifiedByUserId | BackgroundTaskStep->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BackgroundTaskStep->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BackgroundTaskStep->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BackgroundTaskStep->ModifiedOn | string | date-time |\r\n| version | BackgroundTaskStep->Version | integer | int32 |\r\n| id | BackgroundTaskStep->Id | integer | int64 |\r\n| backgroundTaskId | BackgroundTaskStep->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskCompletedSteps | BackgroundTaskStep->BackgroundTask_CompletedSteps | integer | int32 |\r\n| backgroundTaskCompletedOn | BackgroundTaskStep->BackgroundTask_CompletedOn | string | date-time |\r\n| backgroundTaskFailedSteps | BackgroundTaskStep->BackgroundTask_FailedSteps | integer | int32 |\r\n| backgroundTaskCreatedByUserId | BackgroundTaskStep->BackgroundTask_CreatedByUser_Id | integer | int64 |\r\n| backgroundTaskCreatedByUserCode | BackgroundTaskStep->BackgroundTask_CreatedByUser_Code | string | |\r\n| backgroundTaskCreatedByUserFullName | BackgroundTaskStep->BackgroundTask_CreatedByUser_FullName | string | |\r\n| backgroundTaskName | BackgroundTaskStep->BackgroundTask_Name | string | |\r\n| backgroundTaskOrigin | BackgroundTaskStep->BackgroundTask_Origin | string (Allowed values: [User, Job]) | enum |\r\n| backgroundTaskPriority | BackgroundTaskStep->BackgroundTask_Priority | integer | int32 |\r\n| backgroundTaskSkippedSteps | BackgroundTaskStep->BackgroundTask_SkippedSteps | integer | int32 |\r\n| backgroundTaskStartedOn | BackgroundTaskStep->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskStatus | BackgroundTaskStep->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskTotalSteps | BackgroundTaskStep->BackgroundTask_TotalSteps | integer | int32 |\r\n| backgroundTaskTrace | BackgroundTaskStep->BackgroundTask_Trace | object | |\r\n| backgroundTaskType | BackgroundTaskStep->BackgroundTask_Type | string | |\r\n| backgroundTaskCreatedOn | BackgroundTaskStep->BackgroundTaskCreatedOn | string | date-time |\r\n| completedOn | BackgroundTaskStep->CompletedOn | string | date-time |\r\n| origin | BackgroundTaskStep->Origin | string (Allowed values: [User, Job]) | enum |\r\n| isValid | BackgroundTaskStep->IsValid | boolean | |\r\n| name | BackgroundTaskStep->Name | string | |\r\n| priority | BackgroundTaskStep->Priority | integer | int32 |\r\n| request | BackgroundTaskStep->Request | object | |\r\n| requestJson | BackgroundTaskStep->RequestJson | string | |\r\n| requestType | BackgroundTaskStep->RequestType | object | |\r\n| requestTypeFullName | BackgroundTaskStep->RequestTypeFullName | string | |\r\n| response | BackgroundTaskStep->Response | object | |\r\n| sequenceNumber | BackgroundTaskStep->SequenceNumber | integer | int32 |\r\n| skipped | BackgroundTaskStep->Skipped | boolean | |\r\n| startedOn | BackgroundTaskStep->StartedOn | string | date-time |\r\n| trace | BackgroundTaskStep->Trace | object | |\r\n", "operationId": "GetBackgroundTaskStep", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Background Task Step Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Background Task Step", "schema": { "$ref": "#/definitions/GetBackgroundTaskStepResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/Steps": { "get": { "tags": [ "Background Task Step" ], "summary": "Get a collection of Background Task Step 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 | BackgroundTaskStep->Id | integer | int64 |\r\n| name | BackgroundTaskStep->Name | string | |\r\n| backgroundTaskId | BackgroundTaskStep->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | BackgroundTaskStep->BackgroundTask_Name | string | |\r\n| backgroundTaskStatus | BackgroundTaskStep->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskOrigin | BackgroundTaskStep->BackgroundTask_Origin | string (Allowed values: [User, Job]) | enum |\r\n| createdOn | BackgroundTaskStep->CreatedOn | string | date-time |\r\n| modifiedOn | BackgroundTaskStep->ModifiedOn | string | date-time |\r\n| startedOn | BackgroundTaskStep->StartedOn | string | date-time |\r\n| completedOn | BackgroundTaskStep->CompletedOn | string | date-time |\r\n| sequenceNumber | BackgroundTaskStep->SequenceNumber | integer | int32 |\r\n| response | BackgroundTaskStep->Response | object | |\r\n| isValid | BackgroundTaskStep->IsValid | boolean | |\r\n", "operationId": "GetBackgroundTaskStepCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Background Task Step collection", "schema": { "$ref": "#/definitions/GetBackgroundTaskStepCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/BackgroundTasks/Steps/Batch/{ids}": { "get": { "tags": [ "Background Task Step" ], "summary": "Get a collection of Background Task Step 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 | BackgroundTaskStep->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | BackgroundTaskStep->CreatedByUser_Code | string | |\r\n| createdByUserFullName | BackgroundTaskStep->CreatedByUser_FullName | string | |\r\n| createdOn | BackgroundTaskStep->CreatedOn | string | date-time |\r\n| modifiedByUserId | BackgroundTaskStep->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | BackgroundTaskStep->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | BackgroundTaskStep->ModifiedByUser_FullName | string | |\r\n| modifiedOn | BackgroundTaskStep->ModifiedOn | string | date-time |\r\n| version | BackgroundTaskStep->Version | integer | int32 |\r\n| id | BackgroundTaskStep->Id | integer | int64 |\r\n| backgroundTaskId | BackgroundTaskStep->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskCompletedSteps | BackgroundTaskStep->BackgroundTask_CompletedSteps | integer | int32 |\r\n| backgroundTaskCompletedOn | BackgroundTaskStep->BackgroundTask_CompletedOn | string | date-time |\r\n| backgroundTaskFailedSteps | BackgroundTaskStep->BackgroundTask_FailedSteps | integer | int32 |\r\n| backgroundTaskCreatedByUserId | BackgroundTaskStep->BackgroundTask_CreatedByUser_Id | integer | int64 |\r\n| backgroundTaskCreatedByUserCode | BackgroundTaskStep->BackgroundTask_CreatedByUser_Code | string | |\r\n| backgroundTaskCreatedByUserFullName | BackgroundTaskStep->BackgroundTask_CreatedByUser_FullName | string | |\r\n| backgroundTaskName | BackgroundTaskStep->BackgroundTask_Name | string | |\r\n| backgroundTaskOrigin | BackgroundTaskStep->BackgroundTask_Origin | string (Allowed values: [User, Job]) | enum |\r\n| backgroundTaskPriority | BackgroundTaskStep->BackgroundTask_Priority | integer | int32 |\r\n| backgroundTaskSkippedSteps | BackgroundTaskStep->BackgroundTask_SkippedSteps | integer | int32 |\r\n| backgroundTaskStartedOn | BackgroundTaskStep->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskStatus | BackgroundTaskStep->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskTotalSteps | BackgroundTaskStep->BackgroundTask_TotalSteps | integer | int32 |\r\n| backgroundTaskTrace | BackgroundTaskStep->BackgroundTask_Trace | object | |\r\n| backgroundTaskType | BackgroundTaskStep->BackgroundTask_Type | string | |\r\n| backgroundTaskCreatedOn | BackgroundTaskStep->BackgroundTaskCreatedOn | string | date-time |\r\n| completedOn | BackgroundTaskStep->CompletedOn | string | date-time |\r\n| origin | BackgroundTaskStep->Origin | string (Allowed values: [User, Job]) | enum |\r\n| isValid | BackgroundTaskStep->IsValid | boolean | |\r\n| name | BackgroundTaskStep->Name | string | |\r\n| priority | BackgroundTaskStep->Priority | integer | int32 |\r\n| request | BackgroundTaskStep->Request | object | |\r\n| requestJson | BackgroundTaskStep->RequestJson | string | |\r\n| requestType | BackgroundTaskStep->RequestType | object | |\r\n| requestTypeFullName | BackgroundTaskStep->RequestTypeFullName | string | |\r\n| response | BackgroundTaskStep->Response | object | |\r\n| sequenceNumber | BackgroundTaskStep->SequenceNumber | integer | int32 |\r\n| skipped | BackgroundTaskStep->Skipped | boolean | |\r\n| startedOn | BackgroundTaskStep->StartedOn | string | date-time |\r\n| trace | BackgroundTaskStep->Trace | object | |\r\n", "operationId": "BatchGetBackgroundTaskStep", "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 Background Task Step 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 Background Task Step collection", "schema": { "$ref": "#/definitions/BatchGetBackgroundTaskStepResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ChangeLog/Records": { "get": { "tags": [ "Change Log" ], "summary": "Get a collection of Change 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 | RecordChange->Id | integer | int64 |\r\n| persistedOn | RecordChange->PersistedOn | string | date-time |\r\n| changedOn | RecordChange->ChangedOn | string | date-time |\r\n| userId | RecordChange->User_Id | integer | int64 |\r\n| userCode | RecordChange->User_Code | string | |\r\n| userFullName | RecordChange->User_FullName | string | |\r\n| entityId | RecordChange->EntityId | integer | int64 |\r\n| entityType | RecordChange->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| entityChangeType | RecordChange->EntityChangeType | string (Allowed values: [Created, Updated, Deleted]) | enum |\r\n| entityVersion | RecordChange->EntityVersion | integer | int32 |\r\n| requestTypes | RecordChange->RequestTypes | array | array |\r\n| traceId | RecordChange->TraceId | string | |\r\n| requestStepId | RecordChange->RequestStepId | string | uuid |\r\n", "operationId": "GetRecordChangeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Change Log collection", "schema": { "$ref": "#/definitions/GetRecordChangeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ChangeLog/Records/Values": { "get": { "tags": [ "Change Log" ], "summary": "Get a collection of Record Change Value 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| propertyId | RecordChangeValue->Property_Id | integer | int64 |\r\n| propertyPropertyPath | RecordChangeValue->Property_PropertyPath | string | |\r\n| oldValue | RecordChangeValue->OldValue | string | |\r\n| newValue | RecordChangeValue->NewValue | string | |\r\n| recordChangeId | RecordChangeValue->RecordChange_Id | integer | int64 |\r\n| recordChangeEntityId | RecordChangeValue->RecordChange_EntityId | integer | int64 |\r\n| recordChangeUserId | RecordChangeValue->RecordChange_User_Id | integer | int64 |\r\n| recordChangeUserCode | RecordChangeValue->RecordChange_User_Code | string | |\r\n| recordChangeUserFullName | RecordChangeValue->RecordChange_User_FullName | string | |\r\n", "operationId": "GetRecordChangeValueCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Change Log collection", "schema": { "$ref": "#/definitions/GetRecordChangeValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ChangeLog/Records/{recordChangeId}/Values": { "get": { "tags": [ "Change Log" ], "summary": "Get a collection of Record Change Value resources for a Change Log", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| propertyId | RecordChangeValue->Property_Id | integer | int64 |\r\n| propertyPropertyPath | RecordChangeValue->Property_PropertyPath | string | |\r\n| oldValue | RecordChangeValue->OldValue | string | |\r\n| newValue | RecordChangeValue->NewValue | string | |\r\n| recordChangeId | RecordChangeValue->RecordChange_Id | integer | int64 |\r\n", "operationId": "GetRecordChangeValueFromRecordChangeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "recordChangeId", "in": "path", "required": true, "description": "Change Log 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 Change Log collection", "schema": { "$ref": "#/definitions/GetRecordChangeValueFromRecordChangeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ChangeLog/Records/Values/References": { "post": { "tags": [ "Change Log" ], "summary": "Get a list of Record Change Value Reference Value resources", "description": "### Request Body\r\n#### 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 | RecordChangeValuePathIds->Ids | array | array |\r\n| propertyPath | RecordChangeValuePathIds->PropertyPath | 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\r\n\n### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RecordChangeValueReferenceValue->Id | integer | int64 |\r\n| propertyPath | RecordChangeValueReferenceValue->PropertyPath | string | |\r\n| valuePropertyPath | RecordChangeValueReferenceValue->ValuePropertyPath | string | |\r\n| value | RecordChangeValueReferenceValue->Value | string | |\r\n", "operationId": "GetRecordChangeValueReferenceCollection", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/GetRecordChangeValueReferenceCollectionResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains Change Log collection", "schema": { "$ref": "#/definitions/GetRecordChangeValueReferenceCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/DelayedSideEffects/Summary": { "get": { "tags": [ "Delayed Side Effects" ], "summary": "Get a count of the outstanding number of delayed side effects for each delayed side effect type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | DelayedSideEffectSummary->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| queued | DelayedSideEffectSummary->Queued | integer | int64 |\r\n| reason | DelayedSideEffectSummary->Reason | string (Allowed values: [BuildTreePath, CalculateMeterAdr, CalculatePermissionSet, CalculateUserPermissions, GenerateDueTasks, GeneratePredictedMeterReadings, UpdateTaskIsInitialised, UpdateTaskIsReadyForScheduling, WorkOrderTaskGenerated, RegisterCostingItemsForBudgets, RecalculateBudgetAmounts, CalculatedMonitoringPoints, EvaluateMonitoringPointExpressions, EvaluateMonitoringPointBounds, CalculateUserTermsAndConditionVersions, ServiceLevelAgreementPreCalculateStatusDurationUsed]) | enum |\r\n", "operationId": "GetDelayedSideEffectSummaryList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Delayed Side Effects collection", "schema": { "$ref": "#/definitions/GetDelayedSideEffectSummaryListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/DelayedSideEffects/Execute": { "post": { "tags": [ "Delayed Side Effects" ], "summary": "Execute the jobs associated with the delayed side effects.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| reason | DelayedSideEffectSummary->Reason | string (Allowed values: [BuildTreePath, CalculateMeterAdr, CalculatePermissionSet, CalculateUserPermissions, GenerateDueTasks, GeneratePredictedMeterReadings, UpdateTaskIsInitialised, UpdateTaskIsReadyForScheduling, WorkOrderTaskGenerated, RegisterCostingItemsForBudgets, RecalculateBudgetAmounts, CalculatedMonitoringPoints, EvaluateMonitoringPointExpressions, EvaluateMonitoringPointBounds, CalculateUserTermsAndConditionVersions, ServiceLevelAgreementPreCalculateStatusDurationUsed]) | enum |\r\n| entityType | DelayedSideEffectSummary->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\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| reason | Required | True | |\r\n| reason | Nullable | False | |\r\n\r\n", "operationId": "ExecuteDelayedSideEffectJobs", "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/ExecuteDelayedSideEffectJobsResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Entities/{entityType}/DefaultReports": { "post": { "tags": [ "Entities" ], "summary": "Calculate default reports", "description": "### Request Body\r\n#### 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\n### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | DefaultReport->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| reportId | DefaultReport->ReportId | string | |\r\n| entityIds | DefaultReport->EntityIds | array | array |\r\n", "operationId": "CalculateDefaultReports", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "entityType", "in": "path", "required": true, "description": "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]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "EntityType" }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CalculateDefaultReportListResourceActionRequest" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Entities collection", "schema": { "$ref": "#/definitions/CalculateDefaultReportListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/EntityExists": { "post": { "tags": [ "Entity Exists Check" ], "summary": "Check if entities matching the check criteria exist and optionally return their content", "description": "\n", "operationId": "ExecuteExistsCheck", "consumes": [ "application/vnd.onkey.entityexistscheckcollection+json" ], "produces": [ "application/vnd.onkey.entityexistscheckresultcollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "checks", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/EntityExistCheckCollectionSchema" } }, { "type": "boolean", "name": "Hydrate", "in": "query", "description": "Include the hydrated entities with the results (default=False)", "x-nullable": true }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains Entity Exists Check collection", "schema": { "$ref": "#/definitions/EntityExistsCheckResultCollectionSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/HealthIndicators/Tenant": { "get": { "tags": [ "Health" ], "summary": "Get a collection of Tenant Health Indicator 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| identityToken | TenantHealthIndicator->IdentityToken | string | |\r\n| errors | TenantHealthIndicator->Errors | string | |\r\n| healthStatus | TenantHealthIndicator->HealthStatus | string (Allowed values: [Unhealthy, Degraded, Healthy, Unknown]) | enum |\r\n| area | TenantHealthIndicator->Area | string | |\r\n| lastMeasuredOn | TenantHealthIndicator->LastMeasuredOn | string | date-time |\r\n", "operationId": "GetTenantHealthIndicatorList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "lagThreshold", "in": "query", "description": "Lag threshold to use when measuring health (default=300)", "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Health collection", "schema": { "$ref": "#/definitions/GetTenantHealthIndicatorListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/HealthIndicators/Tenant/Values/{area}": { "get": { "tags": [ "Health" ], "summary": "Get a collection of Tenant Health Indicator Value resources for a Tenant Health Indicator 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| area | TenantHealthIndicatorValue->Area | string | |\r\n| name | TenantHealthIndicatorValue->Name | string | |\r\n| severity | TenantHealthIndicatorValue->Severity | string (Allowed values: [Error, Warning, Information]) | enum |\r\n| value | TenantHealthIndicatorValue->Value | object | composite |\r\n", "operationId": "GetTenantHealthIndicatorValueListForArea", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "area", "in": "path", "required": true, "x-nullable": false }, { "type": "integer", "name": "lagThreshold", "in": "query", "description": "Lag threshold to use when measuring health (default=300)", "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Health collection", "schema": { "$ref": "#/definitions/GetTenantHealthIndicatorValueListForAreaResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/HealthIndicators/Tenant/Values": { "get": { "tags": [ "Health" ], "summary": "Get a collection of Tenant Health Indicator Value resources for all Tenant Health Indicator 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| area | TenantHealthIndicatorValue->Area | string | |\r\n| name | TenantHealthIndicatorValue->Name | string | |\r\n| severity | TenantHealthIndicatorValue->Severity | string (Allowed values: [Error, Warning, Information]) | enum |\r\n| value | TenantHealthIndicatorValue->Value | object | composite |\r\n", "operationId": "GetTenantHealthIndicatorValueList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "lagThreshold", "in": "query", "description": "Lag threshold to use when measuring health (default=300)", "format": "int32", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Health collection", "schema": { "$ref": "#/definitions/GetTenantHealthIndicatorValueListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Files/Upload": { "post": { "tags": [ "Import" ], "summary": "Create a new Import resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| importSchemaId | ImportFile->ImportSchema_Id | integer | int64 |\r\n| description | ImportFile->Description | string | |\r\n| executionMode | ImportFile->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| orderedImport | ImportFile->OrderedImport | boolean | |\r\n| fileContent | ImportFile->FileContent | 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| executionMode | Nullable | False | |\r\n| orderedImport | Nullable | False | |\r\n\r\n", "operationId": "UploadImportFile", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UploadImportFileResourceActionRequest" } } ], "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/SYSTEM/Imports/Files": { "post": { "tags": [ "Import" ], "summary": "Import multiple entities using different import actions (Insert, Update, Merge or Delete), using a basic flat file structure", "description": "\n", "operationId": "ExecuteImportFile", "consumes": [ "text/csv" ], "produces": [ "text/csv", "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "csvContent", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CsvContent" } }, { "type": "boolean", "name": "ordered", "in": "query", "description": "Run the import operation in the specified ordered groups (default=False)", "x-nullable": true }, { "type": "integer", "name": "importSchemaId", "in": "query", "description": "Run the file import using the import schema provided", "format": "int64", "x-nullable": true }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "get": { "tags": [ "Import File" ], "summary": "Get a collection of Import File 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 | ImportFile->Id | integer | int64 |\r\n| version | ImportFile->Version | integer | int32 |\r\n| importSchemaId | ImportFile->ImportSchema_Id | integer | int64 |\r\n| importSchemaName | ImportFile->ImportSchema_Name | string | |\r\n| executionMode | ImportFile->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| orderedImport | ImportFile->OrderedImport | boolean | |\r\n| fileName | ImportFile->FileName | string | |\r\n| description | ImportFile->Description | string | |\r\n| backgroundTaskId | ImportFile->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | ImportFile->BackgroundTask_Name | string | |\r\n| backgroundTaskStartedOn | ImportFile->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskStatus | ImportFile->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskFailedSteps | ImportFile->BackgroundTask_FailedSteps | integer | int32 |\r\n| createdOn | ImportFile->CreatedOn | string | date-time |\r\n| createdByUserId | ImportFile->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ImportFile->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ImportFile->CreatedByUser_FullName | string | |\r\n| modifiedOn | ImportFile->ModifiedOn | string | date-time |\r\n", "operationId": "GetImportFileCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Import File collection", "schema": { "$ref": "#/definitions/GetImportFileCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports": { "post": { "tags": [ "Import" ], "summary": "Import multiple entities using different import actions (Insert, Update, Merge or Delete)", "description": "", "operationId": "ExecuteImport", "consumes": [ "application/vnd.onkey.entityimportcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "models", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/EntityImportCollectionSchema" } }, { "type": "boolean", "name": "ordered", "in": "query", "description": "Run the import operation in the specified ordered groups (default=False)", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$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/SYSTEM/Imports/Files/{id}/Download": { "get": { "tags": [ "Import File" ], "summary": "Download the Import File content", "description": "", "operationId": "DownloadImportFile", "produces": [ "text/csv", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import File Id", "format": "int64", "x-nullable": false } ], "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/SYSTEM/Imports/Files/{id}/Results/Download": { "get": { "tags": [ "Import File" ], "summary": "Download the Import File results for importing the data.", "description": "", "operationId": "DownloadImportFileResults", "produces": [ "text/csv", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false } ], "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/SYSTEM/Imports/Files/{id}": { "get": { "tags": [ "Import File" ], "summary": "Get a Import File 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 | ImportFile->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ImportFile->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ImportFile->CreatedByUser_FullName | string | |\r\n| createdOn | ImportFile->CreatedOn | string | date-time |\r\n| modifiedByUserId | ImportFile->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ImportFile->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ImportFile->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ImportFile->ModifiedOn | string | date-time |\r\n| version | ImportFile->Version | integer | int32 |\r\n| id | ImportFile->Id | integer | int64 |\r\n| backgroundTaskId | ImportFile->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | ImportFile->BackgroundTask_Name | string | |\r\n| backgroundTaskStartedOn | ImportFile->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskStatus | ImportFile->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskFailedSteps | ImportFile->BackgroundTask_FailedSteps | integer | int32 |\r\n| description | ImportFile->Description | string | |\r\n| executionMode | ImportFile->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| fileContent | ImportFile->FileContent | array | array |\r\n| fileName | ImportFile->FileName | string | |\r\n| fileResults | ImportFile->FileResults | array | array |\r\n| importSchemaId | ImportFile->ImportSchema_Id | integer | int64 |\r\n| importSchemaName | ImportFile->ImportSchema_Name | string | |\r\n| importSchemaDescription | ImportFile->ImportSchema_Description | string | |\r\n| orderedImport | ImportFile->OrderedImport | boolean | |\r\n", "operationId": "GetImportFile", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import File Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Import File", "schema": { "$ref": "#/definitions/GetImportFileResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Import File" ], "summary": "Delete an existing Import File resource.", "description": "### Request Body\r\n#### 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 | ImportFile->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": "DeleteImportFile", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import File Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteImportFileResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Import File was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Files/{id}/Results": { "get": { "tags": [ "Import File" ], "summary": "Get the results for the Import File executed by the system.", "description": "### Response Body\r\n#### 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 | ImportFileResult->Code | string | |\r\n| entityId | ImportFileResult->EntityId | string | |\r\n| importRecordNumber | ImportFileResult->ImportRecordNumber | integer | int32 |\r\n| message | ImportFileResult->Message | string | memo |\r\n| properties | ImportFileResult->Properties | array | array |\r\n| severity | ImportFileResult->Severity | string (Allowed values: [Error, Warning, Information]) | enum |\r\n", "operationId": "GetImportFileResultList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import File Id", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Import File collection", "schema": { "$ref": "#/definitions/GetImportFileResultListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Files/Lookups/LookupImportFileImportSchema": { "get": { "tags": [ "Import File" ], "summary": "Lookup the Import Schema for the Import File.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ImportSchema->Id | integer | int64 |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n", "operationId": "LookupImportFileImportSchema", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Import Schema collection", "schema": { "$ref": "#/definitions/ImportFileImportSchemaLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Files/Batch/{ids}": { "get": { "tags": [ "Import File" ], "summary": "Get a collection of Import File 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 | ImportFile->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ImportFile->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ImportFile->CreatedByUser_FullName | string | |\r\n| createdOn | ImportFile->CreatedOn | string | date-time |\r\n| modifiedByUserId | ImportFile->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ImportFile->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ImportFile->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ImportFile->ModifiedOn | string | date-time |\r\n| version | ImportFile->Version | integer | int32 |\r\n| id | ImportFile->Id | integer | int64 |\r\n| backgroundTaskId | ImportFile->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | ImportFile->BackgroundTask_Name | string | |\r\n| backgroundTaskStartedOn | ImportFile->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskStatus | ImportFile->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskFailedSteps | ImportFile->BackgroundTask_FailedSteps | integer | int32 |\r\n| description | ImportFile->Description | string | |\r\n| executionMode | ImportFile->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| fileContent | ImportFile->FileContent | array | array |\r\n| fileName | ImportFile->FileName | string | |\r\n| fileResults | ImportFile->FileResults | array | array |\r\n| importSchemaId | ImportFile->ImportSchema_Id | integer | int64 |\r\n| importSchemaName | ImportFile->ImportSchema_Name | string | |\r\n| importSchemaDescription | ImportFile->ImportSchema_Description | string | |\r\n| orderedImport | ImportFile->OrderedImport | boolean | |\r\n", "operationId": "BatchGetImportFile", "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 Import File 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 Import File collection", "schema": { "$ref": "#/definitions/BatchGetImportFileResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Files/Batch": { "delete": { "tags": [ "Import File" ], "summary": "Delete a collection of existing Import File resources.", "description": "### Request Body\r\n#### 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 | ImportFile->Id | integer | int64 |\r\n| version | ImportFile->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": "BatchDeleteImportFile", "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/BatchDeleteImportFileResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Import File batch was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Schemas/{id}/Generate/Csv/Download": { "get": { "tags": [ "Import Schema" ], "summary": "Generate a Import Schema file .csv to use for importing data.", "description": "", "operationId": "GenerateImportCsvFile", "produces": [ "text/csv", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import Schema Id", "format": "int64", "x-nullable": false } ], "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/SYSTEM/Imports/Schemas/{id}": { "get": { "tags": [ "Import Schema" ], "summary": "Get a Import Schema 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 | ImportSchema->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ImportSchema->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ImportSchema->CreatedByUser_FullName | string | |\r\n| createdOn | ImportSchema->CreatedOn | string | date-time |\r\n| modifiedByUserId | ImportSchema->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ImportSchema->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ImportSchema->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ImportSchema->ModifiedOn | string | date-time |\r\n| version | ImportSchema->Version | integer | int32 |\r\n| id | ImportSchema->Id | integer | int64 |\r\n| description | ImportSchema->Description | string | |\r\n| isSystem | ImportSchema->IsSystem | boolean | |\r\n| name | ImportSchema->Name | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| schema | ImportSchema->Schema | string | |\r\n", "operationId": "GetImportSchema", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import Schema Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Import Schema", "schema": { "$ref": "#/definitions/GetImportSchemaResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Import Schema" ], "summary": "Update an existing Import Schema resource.", "description": "### Request Body\r\n#### 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 | ImportSchema->Version | integer | int32 |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| schema | ImportSchema->Schema | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| name | Nullable | False | |\r\n| schema | Nullable | False | |\r\n| restrictionLevel | Nullable | False | |\r\n\r\n", "operationId": "UpdateImportSchema", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import Schema Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateImportSchemaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Import Schema 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": [ "Import Schema" ], "summary": "Delete an existing Import Schema resource.", "description": "### Request Body\r\n#### 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 | ImportSchema->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": "DeleteImportSchema", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import Schema Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteImportSchemaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Import Schema 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/SYSTEM/Imports/Schemas": { "get": { "tags": [ "Import Schema" ], "summary": "Get a collection of Import Schema 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 | ImportSchema->Id | integer | int64 |\r\n| version | ImportSchema->Version | integer | int32 |\r\n| isSystem | ImportSchema->IsSystem | boolean | |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| createdOn | ImportSchema->CreatedOn | string | date-time |\r\n| createdByUserId | ImportSchema->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ImportSchema->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ImportSchema->CreatedByUser_FullName | string | |\r\n| modifiedOn | ImportSchema->ModifiedOn | string | date-time |\r\n", "operationId": "GetImportSchemaCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Import Schema collection", "schema": { "$ref": "#/definitions/GetImportSchemaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Import Schema" ], "summary": "Create a new Import Schema resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| schema | ImportSchema->Schema | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | 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| name | Required | True | |\r\n| name | Nullable | False | |\r\n| schema | Required | True | |\r\n| schema | Nullable | False | |\r\n| restrictionLevel | Nullable | False | |\r\n\r\n", "operationId": "CreateImportSchema", "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/CreateImportSchemaResourceActionRequest" } }, { "$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/SYSTEM/Imports/Schemas/Lookups/LookupImportSchemaSchema": { "get": { "tags": [ "Import Schema" ], "summary": "Lookup the Import Schema for the Import Schema.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ImportSchema->Id | integer | int64 |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| schema | ImportSchema->Schema | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n", "operationId": "LookupImportSchemaSchema", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Import Schema collection", "schema": { "$ref": "#/definitions/ImportSchemaCopySchemaLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Schemas/Batch/{ids}": { "get": { "tags": [ "Import Schema" ], "summary": "Get a collection of Import Schema 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 | ImportSchema->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ImportSchema->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ImportSchema->CreatedByUser_FullName | string | |\r\n| createdOn | ImportSchema->CreatedOn | string | date-time |\r\n| modifiedByUserId | ImportSchema->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ImportSchema->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ImportSchema->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ImportSchema->ModifiedOn | string | date-time |\r\n| version | ImportSchema->Version | integer | int32 |\r\n| id | ImportSchema->Id | integer | int64 |\r\n| csvFileContent | ImportSchema->CsvFileContent | array | array |\r\n| description | ImportSchema->Description | string | |\r\n| isSystem | ImportSchema->IsSystem | boolean | |\r\n| name | ImportSchema->Name | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| schema | ImportSchema->Schema | string | |\r\n", "operationId": "BatchGetImportSchema", "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 Import Schema 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 Import Schema collection", "schema": { "$ref": "#/definitions/BatchGetImportSchemaResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Schemas/Batch": { "post": { "tags": [ "Import Schema" ], "summary": "Create a new collection of Import Schema resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| schema | ImportSchema->Schema | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | 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| name | Required | True | |\r\n| name | Nullable | False | |\r\n| schema | Required | True | |\r\n| schema | Nullable | False | |\r\n| restrictionLevel | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateImportSchema", "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/BatchCreateImportSchemaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Import Schema 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": [ "Import Schema" ], "summary": "Update a collection of existing Import Schema resources.", "description": "### Request Body\r\n#### 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 | ImportSchema->Id | integer | int64 |\r\n| version | ImportSchema->Version | integer | int32 |\r\n| name | ImportSchema->Name | string | |\r\n| description | ImportSchema->Description | string | |\r\n| notes | ImportSchema->Notes | string | |\r\n| schema | ImportSchema->Schema | string | |\r\n| restrictionLevel | ImportSchema->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| name | Nullable | False | |\r\n| schema | Nullable | False | |\r\n| restrictionLevel | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateImportSchema", "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/BatchUpdateImportSchemaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Import Schema 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": [ "Import Schema" ], "summary": "Delete a collection of existing Import Schema resources.", "description": "### Request Body\r\n#### 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 | ImportSchema->Id | integer | int64 |\r\n| version | ImportSchema->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": "BatchDeleteImportSchema", "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/BatchDeleteImportSchemaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Import Schema 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/SYSTEM/Imports/Schemas/{id}/Generate/ExportProfile": { "post": { "tags": [ "Import Schema" ], "summary": "Generate an Export Profile based on the Import Schema to assist with exporting data", "description": "\n### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| templateCustomisationId | GenerateExportProfileResult->TemplateCustomisationId | integer | int64 |\r\n| resourceActionCustomisationId | GenerateExportProfileResult->ResourceActionCustomisationId | integer | int64 |\r\n| template | GenerateExportProfileResult->Template | string | |\r\n| resource | GenerateExportProfileResult->Resource | string | |\r\n| resourceAction | GenerateExportProfileResult->ResourceAction | string | |\r\n| module | GenerateExportProfileResult->Module | string | |\r\n", "operationId": "GenerateExportProfile", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Import Schema Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains Import Schema", "schema": { "$ref": "#/definitions/GenerateExportProfileResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Imports/Schemas/Generate": { "post": { "tags": [ "Import Schema" ], "summary": "Regenerate all the system Import Schema for the release", "description": "", "operationId": "GenerateSystemImportSchemas", "produces": [ "application/vnd.onkey.notification+json" ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Licence/DownloadFile": { "get": { "tags": [ "Licence" ], "summary": "Get the Signed Licence Key file for the Tenant.", "description": "", "operationId": "ExportLicenceKeyFile", "produces": [ "application/vnd.onkey.licence+lic", "application/vnd.onkey.notification+json" ], "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/SYSTEM/Licence": { "get": { "tags": [ "Licence" ], "summary": "Get the Signed Licence Key for the Tenant.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| licence | SignedLicenceKey->Licence | string | |\r\n", "operationId": "ExportLicenceKey", "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 Licence", "schema": { "$ref": "#/definitions/ExportLicenceKeyResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Licence" ], "summary": "Import the Signed Licence Key for the Tenant resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| certificate | SignedLicenceKey->Certificate | string | |\r\n| licence | SignedLicenceKey->Licence | 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| certificate | Required | True | |\r\n| certificate | Nullable | False | |\r\n| licence | Required | True | |\r\n| licence | Nullable | False | |\r\n\r\n", "operationId": "ImportLicenceKey", "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/ImportLicenceKeyResourceActionRequest" } } ], "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/SYSTEM/Licence/Request/DownloadFile": { "get": { "tags": [ "Licence" ], "summary": "Generate a Licence Request file for the Tenant.", "description": "", "operationId": "GenerateLicenceRequestFile", "produces": [ "application/vnd.onkey.licencerequest+qlic", "application/vnd.onkey.notification+json" ], "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/SYSTEM/Licence/Request": { "get": { "tags": [ "Licence" ], "summary": "Generate a Licence Request for the Tenant.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| requestContent | LicenceRequest->RequestContent | string | |\r\n", "operationId": "GenerateLicenceRequest", "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 Licence", "schema": { "$ref": "#/definitions/GenerateLicenceRequestResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Licence/Info": { "get": { "tags": [ "Licence" ], "summary": "Get the Licence for the Tenant.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| licenceStatus | LicenceInfo->LicenceStatus | string (Allowed values: [NotLoaded, NotFound, NotValid, SignatureNotValid, CannotLoad, Loaded]) | enum |\r\n| licenceStatusDescription | LicenceInfo->LicenceStatusDescription | string | |\r\n| client | LicenceInfo->Client | string | |\r\n| environment | LicenceInfo->Environment | string | |\r\n| generatedOn | LicenceInfo->GeneratedOn | string | date-time |\r\n", "operationId": "GetLicenceInfo", "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 Licence", "schema": { "$ref": "#/definitions/GetLicenceInfoResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Licence/Measures": { "get": { "tags": [ "Licence" ], "summary": "Get the Licence Measure collection for the Licence.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| measure | LicenceMeasureInfo->Measure | string (Allowed values: [AssetCount, AssetMsiCount, SiteCount, FileStorage, LicenceRenewalDate, WorkOrderSLAMeasuresInStatusRangeCount]) | enum |\r\n| name | LicenceMeasureInfo->Name | string | |\r\n| category | LicenceMeasureInfo->Category | string | |\r\n| description | LicenceMeasureInfo->Description | string | |\r\n| isActive | LicenceMeasureInfo->IsActive | boolean | |\r\n| lastMeasurement | LicenceMeasureInfo->LastMeasurement | string | |\r\n| currentValue | LicenceMeasureInfo->CurrentValue | string | |\r\n| allowedLimit | LicenceMeasureInfo->AllowedLimit | string | |\r\n| healthStatus | LicenceMeasureInfo->HealthStatus | string (Allowed values: [Unhealthy, Degraded, Healthy, Unknown]) | enum |\r\n| lastMeasuredOn | LicenceMeasureInfo->LastMeasuredOn | string | date-time |\r\n", "operationId": "GetLicenceMeasureList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Licence collection", "schema": { "$ref": "#/definitions/GetLicenceMeasureInfoListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Licence/Reload": { "post": { "tags": [ "Licence" ], "summary": "Reload the licence for the Tenant resource.", "description": "", "operationId": "ReloadLicenceKey", "produces": [ "application/vnd.onkey.notification+json" ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Events/Attachments": { "get": { "tags": [ "Notification Event Attachment Outbox" ], "summary": "Get a collection of Notification Event Attachment Outbox records", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | NotificationEventAttachmentOutbox->Id | integer | int64 |\r\n| attachmentId | NotificationEventAttachmentOutbox->AttachmentId | integer | int64 |\r\n| generatedOn | NotificationEventAttachmentOutbox->GeneratedOn | string | date-time |\r\n| handled | NotificationEventAttachmentOutbox->Handled | boolean | |\r\n| handledOn | NotificationEventAttachmentOutbox->HandledOn | string | date-time |\r\n| response | NotificationEventAttachmentOutbox->Response | string | memo |\r\n| hasContent | NotificationEventAttachmentOutbox->HasContent | boolean | |\r\n| eventOutboxId | NotificationEventAttachmentOutbox->EventOutbox_Id | integer | int64 |\r\n| eventOutboxHandled | NotificationEventAttachmentOutbox->EventOutbox_Handled | boolean | |\r\n| eventOutboxNotificationSource | NotificationEventAttachmentOutbox->EventOutbox_NotificationSource | string (Allowed values: [ChangeDataTrigger, UserInvite, SystemAlert]) | enum |\r\n| eventOutboxNotificationOutputType | NotificationEventAttachmentOutbox->EventOutbox_NotificationOutputType | string (Allowed values: [Email]) | enum |\r\n", "operationId": "GetNotificationEventAttachmentOutboxCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Notification Event Attachment Outbox collection", "schema": { "$ref": "#/definitions/GetNotificationEventAttachmentOutboxCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Events/{eventOutboxId}/Attachments": { "get": { "tags": [ "Notification Event Outbox" ], "summary": "Get a collection of Notification Event Attachment Outbox resources for the Notification Event Outbox.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | NotificationEventAttachmentOutbox->Id | integer | int64 |\r\n| attachmentId | NotificationEventAttachmentOutbox->AttachmentId | integer | int64 |\r\n| generatedOn | NotificationEventAttachmentOutbox->GeneratedOn | string | date-time |\r\n| handledOn | NotificationEventAttachmentOutbox->HandledOn | string | date-time |\r\n| handled | NotificationEventAttachmentOutbox->Handled | boolean | |\r\n| response | NotificationEventAttachmentOutbox->Response | string | memo |\r\n| hasContent | NotificationEventAttachmentOutbox->HasContent | boolean | |\r\n| eventOutboxId | NotificationEventAttachmentOutbox->EventOutbox_Id | integer | int64 |\r\n| eventOutboxNotificationSource | NotificationEventAttachmentOutbox->EventOutbox_NotificationSource | string (Allowed values: [ChangeDataTrigger, UserInvite, SystemAlert]) | enum |\r\n| eventOutboxNotificationOutputType | NotificationEventAttachmentOutbox->EventOutbox_NotificationOutputType | string (Allowed values: [Email]) | enum |\r\n", "operationId": "GetNotificationEventAttachmentOutboxForNotificationEventOutboxCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "eventOutboxId", "in": "path", "required": true, "description": "Notification Event Outbox 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 Notification Event Outbox collection", "schema": { "$ref": "#/definitions/GetNotificationEventAttachmentOutboxForNotificationEventOutboxCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Events": { "get": { "tags": [ "Notification Event Outbox" ], "summary": "Get a collection of Notification Event Outbox records", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | NotificationEventOutbox->Id | integer | int64 |\r\n| notificationSource | NotificationEventOutbox->NotificationSource | string (Allowed values: [ChangeDataTrigger, UserInvite, SystemAlert]) | enum |\r\n| notificationOutputType | NotificationEventOutbox->NotificationOutputType | string (Allowed values: [Email]) | enum |\r\n| attachmentCount | NotificationEventOutbox->AttachmentCount | integer | int32 |\r\n| attachmentRenderedCount | NotificationEventOutbox->AttachmentRenderedCount | integer | int32 |\r\n| generatedOn | NotificationEventOutbox->GeneratedOn | string | date-time |\r\n| handled | NotificationEventOutbox->Handled | boolean | |\r\n| handledOn | NotificationEventOutbox->HandledOn | string | date-time |\r\n| success | NotificationEventOutbox->Success | boolean | |\r\n| notificationTemplateId | NotificationEventOutbox->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateCode | NotificationEventOutbox->NotificationTemplate_Code | string | |\r\n| notificationTemplateDescription | NotificationEventOutbox->NotificationTemplate_Description | string | |\r\n| ignoreTemplateAudience | NotificationEventOutbox->IgnoreTemplateAudience | boolean | |\r\n| response | NotificationEventOutbox->Response | string | memo |\r\n", "operationId": "GetNotificationEventOutboxCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Notification Event Outbox collection", "schema": { "$ref": "#/definitions/GetNotificationEventOutboxCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Events/Errors/Ignore": { "post": { "tags": [ "Notification Event Outbox" ], "summary": "Ignore the errors associated with the Notification Event Outbox.", "description": "### Request Body\r\n#### 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 | NotificationEventOutbox->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": "IgnoreNotificationEventOutboxErrors", "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/IgnoreNotificationEventOutboxErrorsResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Events/Errors/Retry": { "post": { "tags": [ "Notification Event Outbox" ], "summary": "Retry the errors associated with the Notification Event Outbox.", "description": "### Request Body\r\n#### 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 | NotificationEventOutbox->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": "RetryNotificationEventOutboxErrors", "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/RetryNotificationEventOutboxErrorsResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Outbox": { "get": { "tags": [ "Notification Outbox" ], "summary": "Get a collection of Notification Outbox records", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | NotificationOutbox->Id | integer | int64 |\r\n| createdDate | NotificationOutbox->CreatedDate | string | date-time |\r\n| handledDate | NotificationOutbox->HandledDate | string | date-time |\r\n| handledStatus | NotificationOutbox->HandledStatus | string (Allowed values: [NotSent, Sending, Sent, DontRetry, WhitelistedSent, Skipped]) | enum |\r\n| mimeType | NotificationOutbox->MimeType | string | |\r\n| outputType | NotificationOutbox->OutputType | string (Allowed values: [Email]) | enum |\r\n| actualAudienceCount | NotificationOutbox->ActualAudienceCount | integer | int32 |\r\n| skippedAudienceCount | NotificationOutbox->SkippedAudienceCount | integer | int32 |\r\n| invalidAudienceCount | NotificationOutbox->InvalidAudienceCount | integer | int32 |\r\n| attemptedAudienceCount | NotificationOutbox->AttemptedAudienceCount | integer | int32 |\r\n| notificationEventId | NotificationOutbox->NotificationEvent_Id | integer | int64 |\r\n| notificationEventAttachmentCount | NotificationOutbox->NotificationEvent_AttachmentCount | integer | int32 |\r\n| notificationEventNotificationSource | NotificationOutbox->NotificationEvent_NotificationSource | string (Allowed values: [ChangeDataTrigger, UserInvite, SystemAlert]) | enum |\r\n", "operationId": "GetNotificationOutboxCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Notification Outbox collection", "schema": { "$ref": "#/definitions/GetNotificationOutboxCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Outbox/{outboxId}/Log": { "get": { "tags": [ "Notification Outbox" ], "summary": "Get a collection of Notification Outbox Log resources for the Notification Outbox.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | NotificationOutboxLog->Id | integer | int64 |\r\n| handledDate | NotificationOutboxLog->HandledDate | string | date-time |\r\n| success | NotificationOutboxLog->Success | boolean | |\r\n| response | NotificationOutboxLog->Response | string | memo |\r\n| outboxOutputType | NotificationOutboxLog->Outbox_OutputType | string (Allowed values: [Email]) | enum |\r\n", "operationId": "GetNotificationOutboxLogForNotificationOutboxCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "outboxId", "in": "path", "required": true, "description": "Notification Outbox 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 Notification Outbox collection", "schema": { "$ref": "#/definitions/GetNotificationOutboxLogForNotificationOutboxCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Outbox/Log": { "get": { "tags": [ "Notification Outbox Log" ], "summary": "Get a collection of Notification Outbox Log records", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | NotificationOutboxLog->Id | integer | int64 |\r\n| handledDate | NotificationOutboxLog->HandledDate | string | date-time |\r\n| success | NotificationOutboxLog->Success | boolean | |\r\n| response | NotificationOutboxLog->Response | string | memo |\r\n| outboxOutputType | NotificationOutboxLog->Outbox_OutputType | string (Allowed values: [Email]) | enum |\r\n", "operationId": "GetNotificationOutboxLogCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Notification Outbox Log collection", "schema": { "$ref": "#/definitions/GetNotificationOutboxLogCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Outbox/Log/Errors/Ignore": { "post": { "tags": [ "Notification Outbox Log" ], "summary": "Ignore the errors associated with the Notification Outbox Log.", "description": "### Request Body\r\n#### 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 | NotificationOutboxLog->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": "IgnoreNotificationOutboxErrors", "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/IgnoreNotificationOutboxLogErrorsResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Notifications/Outbox/Log/Errors/Resend": { "post": { "tags": [ "Notification Outbox Log" ], "summary": "Resend the errors associated with the Notification Outbox Log.", "description": "### Request Body\r\n#### 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 | NotificationOutboxLog->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": "ResendNotificationOutboxErrors", "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/ResendNotificationOutboxLogErrorsResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ScheduledBackgroundTasks/{id}": { "get": { "tags": [ "Scheduled Background Task" ], "summary": "Get a Scheduled Background 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 | ScheduledBackgroundTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ScheduledBackgroundTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ScheduledBackgroundTask->CreatedByUser_FullName | string | |\r\n| createdOn | ScheduledBackgroundTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | ScheduledBackgroundTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ScheduledBackgroundTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ScheduledBackgroundTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ScheduledBackgroundTask->ModifiedOn | string | date-time |\r\n| version | ScheduledBackgroundTask->Version | integer | int32 |\r\n| id | ScheduledBackgroundTask->Id | integer | int64 |\r\n| executionMode | ScheduledBackgroundTask->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| jobId | ScheduledBackgroundTask->JobId | string | uuid |\r\n| name | ScheduledBackgroundTask->Name | string | |\r\n| notes | ScheduledBackgroundTask->Notes | string | |\r\n| onceOff | ScheduledBackgroundTask->OnceOff | boolean | |\r\n| request | ScheduledBackgroundTask->Request | string | |\r\n| requestType | ScheduledBackgroundTask->RequestType | string | |\r\n| schedule | ScheduledBackgroundTask->Schedule | string | |\r\n| startFrom | ScheduledBackgroundTask->StartFrom | string | date-time |\r\n| trace | ScheduledBackgroundTask->Trace | object | |\r\n| type | ScheduledBackgroundTask->Type | string | |\r\n", "operationId": "GetScheduledBackgroundTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Scheduled Background Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Scheduled Background Task", "schema": { "$ref": "#/definitions/GetScheduledBackgroundTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Scheduled Background Task" ], "summary": "Update an existing Scheduled Background 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 | ScheduledBackgroundTask->Version | integer | int32 |\r\n| schedule | ScheduledBackgroundTask->Schedule | string | |\r\n| startFrom | ScheduledBackgroundTask->StartFrom | string | date-time |\r\n| name | ScheduledBackgroundTask->Name | string | |\r\n| notes | ScheduledBackgroundTask->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| name | Nullable | False | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateScheduledBackgroundTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Scheduled Background Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateScheduledBackgroundTaskResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Scheduled Background Task was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Scheduled Background Task" ], "summary": "Delete an existing Scheduled Background 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 | ScheduledBackgroundTask->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": "DeleteScheduledBackgroundTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Scheduled Background Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteScheduledBackgroundTaskResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Scheduled Background Task was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ScheduledBackgroundTasks": { "get": { "tags": [ "Scheduled Background Task" ], "summary": "Get a collection of Scheduled Background 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 | ScheduledBackgroundTask->Id | integer | int64 |\r\n| name | ScheduledBackgroundTask->Name | string | |\r\n| type | ScheduledBackgroundTask->Type | string | |\r\n| jobId | ScheduledBackgroundTask->JobId | string | uuid |\r\n| schedule | ScheduledBackgroundTask->Schedule | string | |\r\n| executionMode | ScheduledBackgroundTask->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| startFrom | ScheduledBackgroundTask->StartFrom | string | date-time |\r\n| onceOff | ScheduledBackgroundTask->OnceOff | boolean | |\r\n| requestType | ScheduledBackgroundTask->RequestType | string | |\r\n| notes | ScheduledBackgroundTask->Notes | string | |\r\n| createdOn | ScheduledBackgroundTask->CreatedOn | string | date-time |\r\n| modifiedOn | ScheduledBackgroundTask->ModifiedOn | string | date-time |\r\n| version | ScheduledBackgroundTask->Version | integer | int32 |\r\n", "operationId": "GetScheduledBackgroundTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Scheduled Background Task collection", "schema": { "$ref": "#/definitions/GetScheduledBackgroundTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ScheduledBackgroundTasks/Batch/{ids}": { "get": { "tags": [ "Scheduled Background Task" ], "summary": "Get a collection of Scheduled Background 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 | ScheduledBackgroundTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ScheduledBackgroundTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ScheduledBackgroundTask->CreatedByUser_FullName | string | |\r\n| createdOn | ScheduledBackgroundTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | ScheduledBackgroundTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ScheduledBackgroundTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ScheduledBackgroundTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ScheduledBackgroundTask->ModifiedOn | string | date-time |\r\n| version | ScheduledBackgroundTask->Version | integer | int32 |\r\n| id | ScheduledBackgroundTask->Id | integer | int64 |\r\n| executionMode | ScheduledBackgroundTask->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| jobId | ScheduledBackgroundTask->JobId | string | uuid |\r\n| name | ScheduledBackgroundTask->Name | string | |\r\n| notes | ScheduledBackgroundTask->Notes | string | |\r\n| onceOff | ScheduledBackgroundTask->OnceOff | boolean | |\r\n| request | ScheduledBackgroundTask->Request | string | |\r\n| requestType | ScheduledBackgroundTask->RequestType | string | |\r\n| schedule | ScheduledBackgroundTask->Schedule | string | |\r\n| startFrom | ScheduledBackgroundTask->StartFrom | string | date-time |\r\n| trace | ScheduledBackgroundTask->Trace | object | |\r\n| type | ScheduledBackgroundTask->Type | string | |\r\n", "operationId": "BatchGetScheduledBackgroundTask", "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 Scheduled Background 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 Scheduled Background Task collection", "schema": { "$ref": "#/definitions/BatchGetScheduledBackgroundTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/ScheduledBackgroundTasks/Batch": { "patch": { "tags": [ "Scheduled Background Task" ], "summary": "Update a collection of existing Scheduled Background 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 | ScheduledBackgroundTask->Id | integer | int64 |\r\n| version | ScheduledBackgroundTask->Version | integer | int32 |\r\n| schedule | ScheduledBackgroundTask->Schedule | string | |\r\n| startFrom | ScheduledBackgroundTask->StartFrom | string | date-time |\r\n| name | ScheduledBackgroundTask->Name | string | |\r\n| notes | ScheduledBackgroundTask->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| name | Nullable | False | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateScheduledBackgroundTask", "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/BatchUpdateScheduledBackgroundTaskResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Scheduled Background Task batch was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Scheduled Background Task" ], "summary": "Delete a collection of existing Scheduled Background 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 | ScheduledBackgroundTask->Id | integer | int64 |\r\n| version | ScheduledBackgroundTask->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": "BatchDeleteScheduledBackgroundTask", "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/BatchDeleteScheduledBackgroundTaskResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Scheduled Background Task batch was successfully deleted" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Jobs/Schedule/{id}": { "get": { "tags": [ "Scheduled Job" ], "summary": "Get a Scheduled Job 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 | ScheduledJob->Id | integer | int64 |\r\n| version | ScheduledJob->Version | integer | int32 |\r\n| backgroundTaskId | ScheduledJob->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskCompletedSteps | ScheduledJob->BackgroundTask_CompletedSteps | integer | int32 |\r\n| backgroundTaskCompletedOn | ScheduledJob->BackgroundTask_CompletedOn | string | date-time |\r\n| backgroundTaskFailedSteps | ScheduledJob->BackgroundTask_FailedSteps | integer | int32 |\r\n| backgroundTaskCreatedByUserId | ScheduledJob->BackgroundTask_CreatedByUser_Id | integer | int64 |\r\n| backgroundTaskCreatedByUserCode | ScheduledJob->BackgroundTask_CreatedByUser_Code | string | |\r\n| backgroundTaskCreatedByUserFullName | ScheduledJob->BackgroundTask_CreatedByUser_FullName | string | |\r\n| backgroundTaskName | ScheduledJob->BackgroundTask_Name | string | |\r\n| backgroundTaskOrigin | ScheduledJob->BackgroundTask_Origin | string (Allowed values: [User, Job]) | enum |\r\n| backgroundTaskPriority | ScheduledJob->BackgroundTask_Priority | integer | int32 |\r\n| backgroundTaskSkippedSteps | ScheduledJob->BackgroundTask_SkippedSteps | integer | int32 |\r\n| backgroundTaskStartedOn | ScheduledJob->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskStatus | ScheduledJob->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskTotalSteps | ScheduledJob->BackgroundTask_TotalSteps | integer | int32 |\r\n| backgroundTaskTrace | ScheduledJob->BackgroundTask_Trace | object | |\r\n| backgroundTaskType | ScheduledJob->BackgroundTask_Type | string | |\r\n| dispatchedOn | ScheduledJob->DispatchedOn | string | date-time |\r\n| executionMode | ScheduledJob->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| jobId | ScheduledJob->JobId | string | uuid |\r\n| name | ScheduledJob->Name | string | |\r\n| onceOff | ScheduledJob->OnceOff | boolean | |\r\n| origin | ScheduledJob->Origin | string (Allowed values: [System, BackgroundTask]) | enum |\r\n| request | ScheduledJob->Request | string | |\r\n| requestType | ScheduledJob->RequestType | string | |\r\n| response | ScheduledJob->Response | object | |\r\n| runAsUserId | ScheduledJob->RunAsUser_Id | integer | int64 |\r\n| runAsUserCode | ScheduledJob->RunAsUser_Code | string | |\r\n| runAsUserFullName | ScheduledJob->RunAsUser_FullName | string | |\r\n| schedule | ScheduledJob->Schedule | string | |\r\n| scheduledOn | ScheduledJob->ScheduledOn | string | date-time |\r\n| scheduleFrom | ScheduledJob->ScheduleFrom | string | date-time |\r\n| startOn | ScheduledJob->StartOn | string | date-time |\r\n| status | ScheduledJob->Status | string (Allowed values: [Scheduled, Dispatched, Skipped, Faulted, AlreadyRunning]) | enum |\r\n| trace | ScheduledJob->Trace | object | |\r\n| type | ScheduledJob->Type | string | |\r\n", "operationId": "GetScheduledJob", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Scheduled Job Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Scheduled Job", "schema": { "$ref": "#/definitions/GetJobScheduleJobResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Jobs": { "get": { "tags": [ "Scheduled Job" ], "summary": "Get the list of Job resources for the system.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| description | JobInfo->Description | string | |\r\n| jobId | JobInfo->JobId | string | uuid |\r\n| name | JobInfo->Name | string | |\r\n| canRunAdhoc | JobInfo->CanRunAdhoc | boolean | |\r\n| lastCompleted | JobInfo->LastCompleted | string | date-time |\r\n| lastQueued | JobInfo->LastQueued | string | date-time |\r\n| lastRun | JobInfo->LastRun | string | date-time |\r\n| schedule | JobInfo->Schedule | string | |\r\n| scheduleDescription | JobInfo->ScheduleDescription | string | |\r\n", "operationId": "GetJobList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Scheduled Job collection", "schema": { "$ref": "#/definitions/GetJobListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Jobs/{jobId}/Schedule": { "get": { "tags": [ "Scheduled Job" ], "summary": "Get the Scheduled Job resources for a specific Job.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ScheduledJob->Id | integer | int64 |\r\n| name | ScheduledJob->Name | string | |\r\n| type | ScheduledJob->Type | string | |\r\n| origin | ScheduledJob->Origin | string (Allowed values: [System, BackgroundTask]) | enum |\r\n| status | ScheduledJob->Status | string (Allowed values: [Scheduled, Dispatched, Skipped, Faulted, AlreadyRunning]) | enum |\r\n| scheduledOn | ScheduledJob->ScheduledOn | string | date-time |\r\n| dispatchedOn | ScheduledJob->DispatchedOn | string | date-time |\r\n| schedule | ScheduledJob->Schedule | string | |\r\n| scheduleFrom | ScheduledJob->ScheduleFrom | string | date-time |\r\n| startOn | ScheduledJob->StartOn | string | date-time |\r\n| onceOff | ScheduledJob->OnceOff | boolean | |\r\n| executionMode | ScheduledJob->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| requestType | ScheduledJob->RequestType | string | |\r\n| response | ScheduledJob->Response | object | |\r\n| backgroundTaskId | ScheduledJob->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | ScheduledJob->BackgroundTask_Name | string | |\r\n| backgroundTaskStatus | ScheduledJob->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskStartedOn | ScheduledJob->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskCompletedOn | ScheduledJob->BackgroundTask_CompletedOn | string | date-time |\r\n| backgroundTaskTotalSteps | ScheduledJob->BackgroundTask_TotalSteps | integer | int32 |\r\n| backgroundTaskCompletedSteps | ScheduledJob->BackgroundTask_CompletedSteps | integer | int32 |\r\n| backgroundTaskFailedSteps | ScheduledJob->BackgroundTask_FailedSteps | integer | int32 |\r\n", "operationId": "GetJobScheduleForJobCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "jobId", "in": "path", "required": true, "description": "Resource property to use as value", "format": "guid", "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 Scheduled Job collection", "schema": { "$ref": "#/definitions/GetJobScheduleForJobCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Jobs/Schedule": { "get": { "tags": [ "Scheduled Job" ], "summary": "Get a collection of Scheduled Job 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 | ScheduledJob->Id | integer | int64 |\r\n| name | ScheduledJob->Name | string | |\r\n| type | ScheduledJob->Type | string | |\r\n| origin | ScheduledJob->Origin | string (Allowed values: [System, BackgroundTask]) | enum |\r\n| status | ScheduledJob->Status | string (Allowed values: [Scheduled, Dispatched, Skipped, Faulted, AlreadyRunning]) | enum |\r\n| scheduledOn | ScheduledJob->ScheduledOn | string | date-time |\r\n| dispatchedOn | ScheduledJob->DispatchedOn | string | date-time |\r\n| schedule | ScheduledJob->Schedule | string | |\r\n| scheduleFrom | ScheduledJob->ScheduleFrom | string | date-time |\r\n| startOn | ScheduledJob->StartOn | string | date-time |\r\n| onceOff | ScheduledJob->OnceOff | boolean | |\r\n| executionMode | ScheduledJob->ExecutionMode | string (Allowed values: [AllOrNone, PerRecord]) | enum |\r\n| requestType | ScheduledJob->RequestType | string | |\r\n| response | ScheduledJob->Response | object | |\r\n| jobId | ScheduledJob->JobId | string | uuid |\r\n| backgroundTaskId | ScheduledJob->BackgroundTask_Id | integer | int64 |\r\n| backgroundTaskName | ScheduledJob->BackgroundTask_Name | string | |\r\n| backgroundTaskStatus | ScheduledJob->BackgroundTask_Status | string (Allowed values: [NotStarted, Running, Completed, Cancelling, Cancelled, Aborting, Aborted]) | enum |\r\n| backgroundTaskStartedOn | ScheduledJob->BackgroundTask_StartedOn | string | date-time |\r\n| backgroundTaskCompletedOn | ScheduledJob->BackgroundTask_CompletedOn | string | date-time |\r\n| backgroundTaskTotalSteps | ScheduledJob->BackgroundTask_TotalSteps | integer | int32 |\r\n| backgroundTaskCompletedSteps | ScheduledJob->BackgroundTask_CompletedSteps | integer | int32 |\r\n| backgroundTaskFailedSteps | ScheduledJob->BackgroundTask_FailedSteps | integer | int32 |\r\n", "operationId": "GetScheduledJobCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Scheduled Job collection", "schema": { "$ref": "#/definitions/GetJobScheduleJobCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Jobs/{jobId}/Execute": { "post": { "tags": [ "Scheduled Job" ], "summary": "Queue an execution of the Scheduled Job.", "description": "", "operationId": "ExecuteAdhocJob", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "jobId", "in": "path", "required": true, "description": "Resource property to use as value", "format": "guid", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/ChangeDataSubscriptions/Errors": { "get": { "tags": [ "System Logs" ], "summary": "Get the errors within the Change Data Subscription Outbox Error Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| publishedDate | ChangeDataSubscriptionOutboxErrorLog->PublishedDate | string | date-time |\r\n| createdDate | ChangeDataSubscriptionOutboxErrorLog->CreatedDate | string | date-time |\r\n| error | ChangeDataSubscriptionOutboxErrorLog->Error | string | memo |\r\n| changeDataSubscriptionOutboxErrorLogId | ChangeDataSubscriptionOutboxErrorLog->ChangeDataSubscriptionOutboxErrorLogId | integer | int64 |\r\n| messageId | ChangeDataSubscriptionOutboxErrorLog->MessageId | string | uuid |\r\n| topicName | ChangeDataSubscriptionOutboxErrorLog->TopicName | string | |\r\n", "operationId": "GetChangeDataSubscriptionOutboxErrorLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetChangeDataSubscriptionOutboxErrorLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/Conversions": { "get": { "tags": [ "System Logs" ], "summary": "Get the messages within the Conversion Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdDate | ConversionLog->CreatedDate | string | date-time |\r\n| message | ConversionLog->Message | string | memo |\r\n| sourceId | ConversionLog->SourceId | integer | int64 |\r\n| sourceScope | ConversionLog->SourceScope | string | |\r\n| targetId | ConversionLog->TargetId | integer | int64 |\r\n| targetScope | ConversionLog->TargetScope | string | |\r\n| id | ConversionLog->Id | integer | int64 |\r\n", "operationId": "GetConversionLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetConversionLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/DomainEvents/Errors": { "get": { "tags": [ "System Logs" ], "summary": "Get the errors within the Domain Event Outbox Error Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| handledOn | DomainEventOutboxErrorLog->HandledOn | string | date-time |\r\n| error | DomainEventOutboxErrorLog->Error | string | memo |\r\n| domainEventErrorLogId | DomainEventOutboxErrorLog->DomainEventErrorLogId | integer | int64 |\r\n| domainEventId | DomainEventOutboxErrorLog->DomainEventId | integer | int64 |\r\n| domainEventName | DomainEventOutboxErrorLog->DomainEventName | string | |\r\n| domainEventHandler | DomainEventOutboxErrorLog->DomainEventHandler | string | |\r\n", "operationId": "GetDomainEventOutboxErrorLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetDomainEventOutboxErrorLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/DomainEvents/Errors/{domainEventId}": { "get": { "tags": [ "System Logs" ], "summary": "Get the errors within the Domain Event Outbox Error Log for a domain 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| handledOn | DomainEventOutboxErrorLog->HandledOn | string | date-time |\r\n| error | DomainEventOutboxErrorLog->Error | string | memo |\r\n| domainEventErrorLogId | DomainEventOutboxErrorLog->DomainEventErrorLogId | integer | int64 |\r\n| domainEventId | DomainEventOutboxErrorLog->DomainEventId | integer | int64 |\r\n| domainEventName | DomainEventOutboxErrorLog->DomainEventName | string | |\r\n| domainEventHandler | DomainEventOutboxErrorLog->DomainEventHandler | string | |\r\n", "operationId": "GetDomainEventOutboxErrorLogListForDomainEvent", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "domainEventId", "in": "path", "required": true, "description": "Resource property to use as value", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetDomainEventOutboxErrorLogListForDomainEventResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/Messages/Errors/{messageId}": { "get": { "tags": [ "System Logs" ], "summary": "Get the errors within the Message Outbox Error Log for a specific message.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| consumedOn | MessageOutboxErrorLog->ConsumedOn | string | date-time |\r\n| createdOn | MessageOutboxErrorLog->CreatedOn | string | date-time |\r\n| error | MessageOutboxErrorLog->Error | string | memo |\r\n| messageId | MessageOutboxErrorLog->MessageId | string | uuid |\r\n| result | MessageOutboxErrorLog->Result | string (Allowed values: [Success, Ignored, CannotCreateContext, UnhandledException, ConsumerFailed]) | enum |\r\n| consumerType | MessageOutboxErrorLog->ConsumerType | string (Allowed values: [ChangeLog, DomainEvent, Telemetry, OperationEventPulse, DomainEventPulse, BackgroundTaskPulse, SystemEventPulse, Email, ChangeDataSubscription, ChangeDataTrigger]) | enum |\r\n", "operationId": "GetMessageOutboxErrorLogListForMessage", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "messageId", "in": "path", "required": true, "description": "Resource property to use as value", "format": "guid", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetMessageOutboxErrorLogListForMessageResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/Messages/Errors": { "get": { "tags": [ "System Logs" ], "summary": "Get the errors within the Message Outbox Error Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| consumedOn | MessageOutboxErrorLog->ConsumedOn | string | date-time |\r\n| createdOn | MessageOutboxErrorLog->CreatedOn | string | date-time |\r\n| error | MessageOutboxErrorLog->Error | string | memo |\r\n| messageId | MessageOutboxErrorLog->MessageId | string | uuid |\r\n| result | MessageOutboxErrorLog->Result | string (Allowed values: [Success, Ignored, CannotCreateContext, UnhandledException, ConsumerFailed]) | enum |\r\n| consumerType | MessageOutboxErrorLog->ConsumerType | string (Allowed values: [ChangeLog, DomainEvent, Telemetry, OperationEventPulse, DomainEventPulse, BackgroundTaskPulse, SystemEventPulse, Email, ChangeDataSubscription, ChangeDataTrigger]) | enum |\r\n", "operationId": "GetMessageOutboxErrorLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetMessageOutboxErrorLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/Migrations": { "get": { "tags": [ "System Logs" ], "summary": "Get the log entries within the Migration Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TenantMigrationLog->Id | integer | int64 |\r\n| migrationId | TenantMigrationLog->MigrationId | string | uuid |\r\n| elapsedTime | TenantMigrationLog->ElapsedTime | string | duration |\r\n| name | TenantMigrationLog->Name | string | |\r\n| groupName | TenantMigrationLog->GroupName | string | |\r\n| response | TenantMigrationLog->Response | object | |\r\n| responseIsValid | TenantMigrationLog->ResponseIsValid | boolean | |\r\n| message | TenantMigrationLog->Message | string | |\r\n| onKeyBuildNumber | TenantMigrationLog->OnKeyBuildNumber | integer | int32 |\r\n| onKeyVersionNumber | TenantMigrationLog->OnKeyVersionNumber | string | |\r\n| runOn | TenantMigrationLog->RunOn | string | date-time |\r\n| database | TenantMigrationLog->Database | string (Allowed values: [Transaction, Insights, Config, FileContentStore, Archive]) | enum |\r\n", "operationId": "GetMigrationLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetMigrationLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/ResourceActionMigrations": { "get": { "tags": [ "System Logs" ], "summary": "Get the log entries within the Resource Action Migration Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ResourceActionMigrationLog->Id | integer | int64 |\r\n| createdByUserId | ResourceActionMigrationLog->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ResourceActionMigrationLog->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ResourceActionMigrationLog->CreatedByUser_FullName | string | |\r\n| createdOn | ResourceActionMigrationLog->CreatedOn | string | date-time |\r\n| modifiedByUserId | ResourceActionMigrationLog->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ResourceActionMigrationLog->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ResourceActionMigrationLog->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ResourceActionMigrationLog->ModifiedOn | string | date-time |\r\n| version | ResourceActionMigrationLog->Version | integer | int32 |\r\n| action | ResourceActionMigrationLog->Action | string (Allowed values: [Migrate, Clean, Validate]) | enum |\r\n| customisationId | ResourceActionMigrationLog->Customisation_Id | integer | int64 |\r\n| customisationName | ResourceActionMigrationLog->Customisation_Name | string | |\r\n| customisationDescription | ResourceActionMigrationLog->Customisation_Description | string | |\r\n| customisationModule | ResourceActionMigrationLog->Customisation_Module | string | |\r\n| customisationResource | ResourceActionMigrationLog->Customisation_Resource | string | |\r\n| customisationResourceAction | ResourceActionMigrationLog->Customisation_ResourceAction | string | |\r\n| customisationRestrictionLevel | ResourceActionMigrationLog->Customisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| intent | ResourceActionMigrationLog->Intent | string | |\r\n| intentType | ResourceActionMigrationLog->IntentType | string (Allowed values: [RenameProperty, RemoveProperty]) | enum |\r\n| message | ResourceActionMigrationLog->Message | string | memo |\r\n| onKeyTargetVersionNumber | ResourceActionMigrationLog->OnKeyTargetVersionNumber | string | |\r\n| runOn | ResourceActionMigrationLog->RunOn | string | date-time |\r\n| success | ResourceActionMigrationLog->Success | boolean | |\r\n", "operationId": "GetResourceActionMigrationLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetResourceActionMigrationLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/TemplateMigrations/{templateMigrationId}/Intents": { "get": { "tags": [ "System Logs" ], "summary": "Get the list of Template Migration Log Intent resources executed for a Template Migration 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| id | TemplateMigrationLogIntent->Id | integer | int64 |\r\n| version | TemplateMigrationLogIntent->Version | integer | int32 |\r\n| action | TemplateMigrationLogIntent->Action | string | |\r\n| area | TemplateMigrationLogIntent->Area | string | |\r\n| description | TemplateMigrationLogIntent->Description | string | |\r\n| importance | TemplateMigrationLogIntent->Importance | string (Allowed values: [High, Medium, Low]) | enum |\r\n| message | TemplateMigrationLogIntent->Message | string | memo |\r\n| severity | TemplateMigrationLogIntent->Severity | string (Allowed values: [Error, Warning, Information]) | enum |\r\n| templateMigrationId | TemplateMigrationLogIntent->TemplateMigration_Id | integer | int64 |\r\n| templateMigrationMessage | TemplateMigrationLogIntent->TemplateMigration_Message | string | memo |\r\n| templateMigrationName | TemplateMigrationLogIntent->TemplateMigration_Name | string | |\r\n| templateMigrationSuccess | TemplateMigrationLogIntent->TemplateMigration_Success | boolean | |\r\n| templateMigrationRunOn | TemplateMigrationLogIntent->TemplateMigration_RunOn | string | date-time |\r\n", "operationId": "GetTemplateMigrationLogIntentList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "templateMigrationId", "in": "path", "required": true, "description": "Template Migration Log Id", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetTemplateMigrationLogIntentListForMigrationResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/TemplateMigrations": { "get": { "tags": [ "System Logs" ], "summary": "Get the log entries within the Template Migration Log.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TemplateMigrationLog->Id | integer | int64 |\r\n| createdByUserId | TemplateMigrationLog->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TemplateMigrationLog->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TemplateMigrationLog->CreatedByUser_FullName | string | |\r\n| createdOn | TemplateMigrationLog->CreatedOn | string | date-time |\r\n| modifiedByUserId | TemplateMigrationLog->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TemplateMigrationLog->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TemplateMigrationLog->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TemplateMigrationLog->ModifiedOn | string | date-time |\r\n| version | TemplateMigrationLog->Version | integer | int32 |\r\n| action | TemplateMigrationLog->Action | string (Allowed values: [Migrate, Clean, Validate]) | enum |\r\n| customisationId | TemplateMigrationLog->Customisation_Id | integer | int64 |\r\n| customisationDescription | TemplateMigrationLog->Customisation_Description | string | |\r\n| customisationModule | TemplateMigrationLog->Customisation_Module | string | |\r\n| customisationName | TemplateMigrationLog->Customisation_Name | string | |\r\n| customisationTemplate | TemplateMigrationLog->Customisation_Template | string | |\r\n| customisationType | TemplateMigrationLog->Customisation_Type | string | |\r\n| customisationRestrictionLevel | TemplateMigrationLog->Customisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| customisationCreatedByUserId | TemplateMigrationLog->Customisation_CreatedByUser_Id | integer | int64 |\r\n| customisationCreatedByUserCode | TemplateMigrationLog->Customisation_CreatedByUser_Code | string | |\r\n| customisationCreatedByUserFullName | TemplateMigrationLog->Customisation_CreatedByUser_FullName | string | |\r\n| message | TemplateMigrationLog->Message | string | memo |\r\n| name | TemplateMigrationLog->Name | string | |\r\n| onKeyTargetVersionNumber | TemplateMigrationLog->OnKeyTargetVersionNumber | string | |\r\n| onKeyVersionNumber | TemplateMigrationLog->OnKeyVersionNumber | string | |\r\n| runOn | TemplateMigrationLog->RunOn | string | date-time |\r\n| success | TemplateMigrationLog->Success | boolean | |\r\n| templateVersionNumber | TemplateMigrationLog->TemplateVersionNumber | integer | int32 |\r\n", "operationId": "GetTemplateMigrationLogList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Logs collection", "schema": { "$ref": "#/definitions/GetTemplateMigrationLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/ChangeDataSubscriptions/Errors/Ignore": { "post": { "tags": [ "System Logs" ], "summary": "Ignore the change data subscription events associated with the Change Data Subscription Outbox Error Log.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| changeDataSubscriptionOutboxErrorLogId | ChangeDataSubscriptionOutboxErrorLog->ChangeDataSubscriptionOutboxErrorLogId | 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| changeDataSubscriptionOutboxErrorLogId | Required | True | |\r\n| changeDataSubscriptionOutboxErrorLogId | Nullable | False | |\r\n\r\n", "operationId": "IgnoreChangeDataSubscriptionOutboxErrorLog", "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/IgnoreChangeDataSubscriptionOutboxErrorLogResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/DomainEvents/Errors/Ignore": { "post": { "tags": [ "System Logs" ], "summary": "Ignore the domain events associated with the Domain Event Outbox Error Log.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| domainEventId | DomainEventOutboxErrorLog->DomainEventId | 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| domainEventId | Required | True | |\r\n| domainEventId | Nullable | False | |\r\n\r\n", "operationId": "IgnoreDomainEventOutboxErrorLog", "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/IgnoreDomainEventOutboxErrorLogResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/Messages/Errors/Ignore": { "post": { "tags": [ "System Logs" ], "summary": "Ignore the messages associated with the Message Outbox Error Log.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| messageId | MessageOutboxErrorLog->MessageId | string | uuid |\r\n| consumerType | MessageOutboxErrorLog->ConsumerType | string (Allowed values: [ChangeLog, DomainEvent, Telemetry, OperationEventPulse, DomainEventPulse, BackgroundTaskPulse, SystemEventPulse, Email, ChangeDataSubscription, ChangeDataTrigger]) | 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| messageId | Required | True | |\r\n| messageId | Nullable | False | |\r\n| consumerType | Required | True | |\r\n| consumerType | Nullable | False | |\r\n\r\n", "operationId": "IgnoreMessageOutboxErrorLog", "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/IgnoreMessageOutboxErrorLogResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/DomainEvents/Errors/Replay": { "post": { "tags": [ "System Logs" ], "summary": "Replay the domain events associated with the Domain Event Outbox Error Log.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| domainEventId | DomainEventOutboxErrorLog->DomainEventId | 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| domainEventId | Required | True | |\r\n| domainEventId | Nullable | False | |\r\n\r\n", "operationId": "ReplayDomainEventOutboxErrorLog", "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/ReplayDomainEventOutboxErrorLogResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/Messages/Errors/Replay": { "post": { "tags": [ "System Logs" ], "summary": "Replay the messages associated with the Message Outbox Error Log.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| messageId | MessageOutboxErrorLog->MessageId | string | uuid |\r\n| consumerType | MessageOutboxErrorLog->ConsumerType | string (Allowed values: [ChangeLog, DomainEvent, Telemetry, OperationEventPulse, DomainEventPulse, BackgroundTaskPulse, SystemEventPulse, Email, ChangeDataSubscription, ChangeDataTrigger]) | 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| messageId | Required | True | |\r\n| messageId | Nullable | False | |\r\n| consumerType | Required | True | |\r\n| consumerType | Nullable | False | |\r\n\r\n", "operationId": "ReplayMessageOutboxErrorLog", "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/ReplayMessageOutboxErrorLogResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Logs/TemplateMigrations/Restore": { "patch": { "tags": [ "System Logs" ], "summary": "Restore the customisations associated with the Template Migration Log to their system default 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| id | TemplateMigrationLog->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": "RestoreDefaultTemplateMigrationLog", "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/RestoreDefaultTemplateMigrationLogResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Modules/AMPC": { "get": { "tags": [ "System Option" ], "summary": "Get the subset of AMPC module options for the System Option 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 | SystemOption->Id | integer | int64 |\r\n| version | SystemOption->Version | integer | int32 |\r\n| allowDuplicateTaskLabour | SystemOption->AllowDuplicateTaskLabour | boolean | |\r\n| alwaysAllowMultipleOptionValues | SystemOption->AlwaysAllowMultipleOptionValues | boolean | |\r\n| allowDuplicateTaskSpares | SystemOption->AllowDuplicateTaskSpares | boolean | |\r\n", "operationId": "GetSystemOptionAMPCModule", "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 System Option", "schema": { "$ref": "#/definitions/GetSystemOptionAMPCModuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Modules/AOM": { "get": { "tags": [ "System Option" ], "summary": "Get the subset of AOM module options for the System Option 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 | SystemOption->Id | integer | int64 |\r\n| version | SystemOption->Version | integer | int32 |\r\n| averageDailyRateVariancePercentage | SystemOption->AverageDailyRateVariancePercentage | number | decimal |\r\n| alignAssetTasksAfterMeterReset | SystemOption->AlignAssetTasksAfterMeterReset | boolean | |\r\n| validateAverageDailyRateVariancePercentage | SystemOption->ValidateAverageDailyRateVariancePercentage | boolean | |\r\n", "operationId": "GetSystemOptionAOMModule", "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 System Option", "schema": { "$ref": "#/definitions/GetSystemOptionAOMModuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Modules/FIN": { "get": { "tags": [ "System Option" ], "summary": "Get the subset of FIN module options for the System Option 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 | SystemOption->Id | integer | int64 |\r\n| version | SystemOption->Version | integer | int32 |\r\n| enableCosting | SystemOption->EnableCosting | boolean | |\r\n", "operationId": "GetSystemOptionFINModule", "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 System Option", "schema": { "$ref": "#/definitions/GetSystemOptionFINModuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Modules/MM": { "get": { "tags": [ "System Option" ], "summary": "Get the subset of MM module options for the System Option 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 | SystemOption->Id | integer | int64 |\r\n| version | SystemOption->Version | integer | int32 |\r\n| allowIssuingOnClosedRequisition | SystemOption->AllowIssuingOnClosedRequisition | boolean | |\r\n| allowStockAndNonStockOnTheSameRequisition | SystemOption->AllowStockAndNonStockOnTheSameRequisition | boolean | |\r\n| autoCreateRequisitionsOnScheduledWorkOrders | SystemOption->AutoCreateRequisitionsOnScheduledWorkOrders | boolean | |\r\n| defaultNewRequisitionStatusId | SystemOption->DefaultNewRequisitionStatus_Id | integer | int64 |\r\n| defaultRequisitionStatusWhenIssuedToCompletionId | SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Id | integer | int64 |\r\n| enableRequisitions | SystemOption->EnableRequisitions | boolean | |\r\n| enableRequisitionApprovalWorkflow | SystemOption->EnableRequisitionApprovalWorkflow | boolean | |\r\n| useUserRequisitionLimits | SystemOption->UseUserRequisitionLimits | boolean | |\r\n| requisitionCodePrefix | SystemOption->RequisitionCodePrefix | string | |\r\n| requisitionCodeLength | SystemOption->RequisitionCodeLength | integer | int32 |\r\n", "operationId": "GetSystemOptionMMModule", "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 System Option", "schema": { "$ref": "#/definitions/GetSystemOptionMMModuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options": { "get": { "tags": [ "System Option" ], "summary": "Get the options across all modules for the System Option 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 | SystemOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOption->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOption->ModifiedOn | string | date-time |\r\n| version | SystemOption->Version | integer | int32 |\r\n| id | SystemOption->Id | integer | int64 |\r\n| reportServerReportLanguage | SystemOption->ReportServerReportLanguage | string | |\r\n| reportServerReportLanguageDisplayName | SystemOption->ReportServerReportLanguageDisplayName | string | |\r\n| reportServerUILanguage | SystemOption->ReportServerUILanguage | string | |\r\n| reportServerUILanguageDisplayName | SystemOption->ReportServerUILanguageDisplayName | string | |\r\n| allowCaseSensitiveCodeFields | SystemOption->AllowCaseSensitiveCodeFields | boolean | |\r\n| allowDuplicateTaskLabour | SystemOption->AllowDuplicateTaskLabour | boolean | |\r\n| allowDuplicateTaskSpares | SystemOption->AllowDuplicateTaskSpares | boolean | |\r\n| alwaysAllowMultipleOptionValues | SystemOption->AlwaysAllowMultipleOptionValues | boolean | |\r\n| aOMModuleId | SystemOption->AOMModuleId | integer | int64 |\r\n| alignAssetTasksAfterMeterReset | SystemOption->AlignAssetTasksAfterMeterReset | boolean | |\r\n| averageDailyRateVariancePercentage | SystemOption->AverageDailyRateVariancePercentage | number | decimal |\r\n| validateAverageDailyRateVariancePercentage | SystemOption->ValidateAverageDailyRateVariancePercentage | boolean | |\r\n| autoUpperCaseCodes | SystemOption->AutoUpperCaseCodes | boolean | |\r\n| baseCurrencyId | SystemOption->BaseCurrency_Id | integer | int64 |\r\n| baseCurrencyCode | SystemOption->BaseCurrency_Code | string | |\r\n| baseCurrencyDescription | SystemOption->BaseCurrency_Description | string | |\r\n| companyName | SystemOption->CompanyName | string | |\r\n| contentTranslate | SystemOption->ContentTranslate | boolean | |\r\n| dateFormat | SystemOption->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | SystemOption->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultAssetDevelopmentStatusApplyToChildren | SystemOption->DefaultAssetDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultAssetTypeDevelopmentStatusApplyToChildren | SystemOption->DefaultAssetTypeDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultAssetTypeDevelopmentStatusApplyToDescendants | SystemOption->DefaultAssetTypeDevelopmentStatusApplyToDescendants | boolean | |\r\n| defaultCreateSaveAction | SystemOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultFirstWeekOfTheYear | SystemOption->DefaultFirstWeekOfTheYear | string (Allowed values: [StartsOnJan1, First4DayWeek, FirstFullWeek]) | enum |\r\n| defaultIsActiveApplyToChildren | SystemOption->DefaultIsActiveApplyToChildren | boolean | |\r\n| defaultIsActiveApplyToDescendants | SystemOption->DefaultIsActiveApplyToDescendants | boolean | |\r\n| defaultIsActiveApplyToDetails | SystemOption->DefaultIsActiveApplyToDetails | boolean | |\r\n| defaultLanguageId | SystemOption->DefaultLanguage_Id | integer | int64 |\r\n| defaultLanguageCode | SystemOption->DefaultLanguage_Code | string | |\r\n| defaultLanguageDescription | SystemOption->DefaultLanguage_Description | string | |\r\n| defaultPageLimit | SystemOption->DefaultPageLimit | integer | int32 |\r\n| defaultResourceDurationUnitOfMeasurement | SystemOption->DefaultResourceDurationUnitOfMeasurement | integer | int64 |\r\n| defaultSyncDevelopmentStatusApplyToChildren | SystemOption->DefaultSyncDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultTradeLookup | SystemOption->DefaultTradeLookup | string (Allowed values: [AllTrades, SectionTrades]) | enum |\r\n| defaultUpdateSaveAction | SystemOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| displayMultipleCurrencyFields | SystemOption->DisplayMultipleCurrencyFields | boolean | |\r\n| fINModuleId | SystemOption->FINModuleId | integer | int64 |\r\n| enableCosting | SystemOption->EnableCosting | boolean | |\r\n| mMModuleId | SystemOption->MMModuleId | integer | int64 |\r\n| allowIssuingOnClosedRequisition | SystemOption->AllowIssuingOnClosedRequisition | boolean | |\r\n| allowStockAndNonStockOnTheSameRequisition | SystemOption->AllowStockAndNonStockOnTheSameRequisition | boolean | |\r\n| autoCreateRequisitionsOnScheduledWorkOrders | SystemOption->AutoCreateRequisitionsOnScheduledWorkOrders | boolean | |\r\n| defaultNewRequisitionStatusId | SystemOption->DefaultNewRequisitionStatus_Id | integer | int64 |\r\n| defaultNewRequisitionStatusCode | SystemOption->DefaultNewRequisitionStatus_Code | string | |\r\n| defaultNewRequisitionStatusDescription | SystemOption->DefaultNewRequisitionStatus_Description | string | |\r\n| defaultRequisitionStatusWhenIssuedToCompletionId | SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Id | integer | int64 |\r\n| defaultRequisitionStatusWhenIssuedToCompletionCode | SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Code | string | |\r\n| defaultRequisitionStatusWhenIssuedToCompletionDescription | SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Description | string | |\r\n| enableRequisitions | SystemOption->EnableRequisitions | boolean | |\r\n| enableRequisitionApprovalWorkflow | SystemOption->EnableRequisitionApprovalWorkflow | boolean | |\r\n| requisitionCodeLength | SystemOption->RequisitionCodeLength | integer | int32 |\r\n| requisitionCodePrefix | SystemOption->RequisitionCodePrefix | string | |\r\n| useUserRequisitionLimits | SystemOption->UseUserRequisitionLimits | boolean | |\r\n| supportEmail | SystemOption->SupportEmail | string | |\r\n| supportPerson | SystemOption->SupportPerson | string | |\r\n| supportPhoneNumber | SystemOption->SupportPhoneNumber | string | |\r\n| synchroniseSiteTreeWithPermissionTree | SystemOption->SynchroniseSiteTreeWithPermissionTree | boolean | |\r\n| timeFormat | SystemOption->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| allowContractorItems | SystemOption->AllowContractorItems | boolean | |\r\n| allowDirectPurchaseItems | SystemOption->AllowDirectPurchaseItems | boolean | |\r\n| allowNoLabourFeedbackOnClosedWorkOrders | SystemOption->AllowNoLabourFeedbackOnClosedWorkOrders | boolean | |\r\n| allowTaskSpareDeletes | SystemOption->AllowTaskSpareDeletes | boolean | |\r\n| allowWorkOrdersWithoutAssets | SystemOption->AllowWorkOrdersWithoutAssets | boolean | |\r\n| applySuppressionOnSplitAndMergeAction | SystemOption->ApplySuppressionOnSplitAndMergeAction | boolean | |\r\n| assetImportanceWeight | SystemOption->AssetImportanceWeight | number | decimal |\r\n| autoCalculateEstimatedDowntimeForFollowUpWorkOrders | SystemOption->AutoCalculateEstimatedDowntimeForFollowUpWorkOrders | boolean | |\r\n| autoCalculateEstimatedDowntimeForManualWorkOrders | SystemOption->AutoCalculateEstimatedDowntimeForManualWorkOrders | boolean | |\r\n| autoCalculateEstimatedDowntimeForScheduledWorkOrders | SystemOption->AutoCalculateEstimatedDowntimeForScheduledWorkOrders | boolean | |\r\n| autoCalculateEstimatedDurationForFollowUpWorkOrders | SystemOption->AutoCalculateEstimatedDurationForFollowUpWorkOrders | boolean | |\r\n| autoCalculateEstimatedDurationForManualWorkOrders | SystemOption->AutoCalculateEstimatedDurationForManualWorkOrders | boolean | |\r\n| autoCalculateEstimatedDurationForScheduledWorkOrders | SystemOption->AutoCalculateEstimatedDurationForScheduledWorkOrders | boolean | |\r\n| autoPopulateStartOnAndCompleteByDates | SystemOption->AutoPopulateStartOnAndCompleteByDates | boolean | |\r\n| autoUpdateCompletedOnDate | SystemOption->AutoUpdateCompletedOnDate | boolean | |\r\n| calculateScheduledMetersFieldOnWorkOrders | SystemOption->CalculateScheduledMetersFieldOnWorkOrders | boolean | |\r\n| checkStatusChangeWhenComplete | SystemOption->CheckStatusChangeWhenComplete | boolean | |\r\n| combineResourcesOnSingleTask | SystemOption->CombineResourcesOnSingleTask | string (Allowed values: [AlwaysAsk, Always, Never]) | enum |\r\n| completeByDateCustomised | SystemOption->CompleteByDateCustomised | boolean | |\r\n| contractorItemsCodesMandatory | SystemOption->ContractorItemsCodesMandatory | boolean | |\r\n| defaultStatusId | SystemOption->DefaultStatus_Id | integer | int64 |\r\n| defaultStatusCode | SystemOption->DefaultStatus_Code | string | |\r\n| defaultStatusDescription | SystemOption->DefaultStatus_Description | string | |\r\n| defaultWorkRequestAwaitingApprovalStatusId | SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Id | integer | int64 |\r\n| defaultWorkRequestAwaitingApprovalStatusCode | SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Code | string | |\r\n| defaultWorkRequestAwaitingApprovalStatusDescription | SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Description | string | |\r\n| defaultWorkRequestCancelledStatusId | SystemOption->DefaultWorkRequestCancelledStatus_Id | integer | int64 |\r\n| defaultWorkRequestCancelledStatusCode | SystemOption->DefaultWorkRequestCancelledStatus_Code | string | |\r\n| defaultWorkRequestCancelledStatusDescription | SystemOption->DefaultWorkRequestCancelledStatus_Description | string | |\r\n| defaultWorkRequestClosedStatusId | SystemOption->DefaultWorkRequestClosedStatus_Id | integer | int64 |\r\n| defaultWorkRequestClosedStatusCode | SystemOption->DefaultWorkRequestClosedStatus_Code | string | |\r\n| defaultWorkRequestClosedStatusDescription | SystemOption->DefaultWorkRequestClosedStatus_Description | string | |\r\n| dueCalendarTasksLookBackPeriod | SystemOption->DueCalendarTasksLookBackPeriod | string | duration |\r\n| dueTasksFutureRange | SystemOption->DueTasksFutureRange | integer | int32 |\r\n| enableSla | SystemOption->EnableSla | boolean | |\r\n| enforceAssetWarranty | SystemOption->EnforceAssetWarranty | boolean | |\r\n| failureAnalysisCustomised | SystemOption->FailureAnalysisCustomised | boolean | |\r\n| followUpTaskResponsibility | SystemOption->FollowUpTaskResponsibility | string (Allowed values: [FollowUpAssetTaskResponsibility, SourceWorkOrderResponsibility]) | enum |\r\n| followUpWorkOrderCatchStatus | SystemOption->FollowUpWorkOrderCatchStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| followUpWorkOrderCustomised | SystemOption->FollowUpWorkOrderCustomised | boolean | |\r\n| followUpWorkOrderTasksGroupBySection | SystemOption->FollowUpWorkOrderTasksGroupBySection | boolean | |\r\n| followUpWorkOrderTasksGroupByTrade | SystemOption->FollowUpWorkOrderTasksGroupByTrade | boolean | |\r\n| followUpWorkOrderTypeOfWorkId | SystemOption->FollowUpWorkOrderTypeOfWork_Id | integer | int64 |\r\n| followUpWorkOrderTypeOfWorkCode | SystemOption->FollowUpWorkOrderTypeOfWork_Code | string | |\r\n| followUpWorkOrderTypeOfWorkDescription | SystemOption->FollowUpWorkOrderTypeOfWork_Description | string | |\r\n| followUpWorkOrderTypeOfWorkWorkClass | SystemOption->FollowUpWorkOrderTypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| followUpWorkOrderTypeOfWorkWorkType | SystemOption->FollowUpWorkOrderTypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| labourRequiredCustomised | SystemOption->LabourRequiredCustomised | boolean | |\r\n| mandatoryTasksCustomised | SystemOption->MandatoryTasksCustomised | boolean | |\r\n| mergeAllowedWorkOrderStatus | SystemOption->MergeAllowedWorkOrderStatus | string (Allowed values: [AwaitingApproval, Approved, AwaitingApprovalOrApproved]) | enum |\r\n| mergeAndSplitCancelledWorkOrderStatusId | SystemOption->MergeAndSplitCancelledWorkOrderStatus_Id | integer | int64 |\r\n| mergeAndSplitCancelledWorkOrderStatusCode | SystemOption->MergeAndSplitCancelledWorkOrderStatus_Code | string | |\r\n| mergeAndSplitCancelledWorkOrderStatusDescription | SystemOption->MergeAndSplitCancelledWorkOrderStatus_Description | string | |\r\n| mergeAndSplitInformationOnWorkOrder | SystemOption->MergeAndSplitInformationOnWorkOrder | boolean | |\r\n| mergeResourcesOnDuplicateAssetTasks | SystemOption->MergeResourcesOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeResourcesOnDuplicateStandardTasks | SystemOption->MergeResourcesOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSparesOnDuplicateAssetTasks | SystemOption->MergeSparesOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSparesOnDuplicateStandardTasks | SystemOption->MergeSparesOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSubTasksOnDuplicateAssetTasks | SystemOption->MergeSubTasksOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSubTasksOnDuplicateStandardTasks | SystemOption->MergeSubTasksOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeTypeOfWorkOption | SystemOption->MergeTypeOfWorkOption | string (Allowed values: [NoRestriction, TypeOfWorkClass, TypeOfWork]) | enum |\r\n| permitNumberCustomised | SystemOption->PermitNumberCustomised | boolean | |\r\n| predictedMeterReadingsLookBackPeriod | SystemOption->PredictedMeterReadingsLookBackPeriod | string | duration |\r\n| priorityBasedOn | SystemOption->PriorityBasedOn | string (Allowed values: [HighestWorkOrderTaskPriority, LowestWorkOrderTaskPriority]) | enum |\r\n| proposedWorkDefaultGroupingInterval | SystemOption->ProposedWorkDefaultGroupingInterval | integer | int32 |\r\n| proposedWorkDefaultTaskGroupingStartDate | SystemOption->ProposedWorkDefaultTaskGroupingStartDate | string | date-time |\r\n| proposedWorkOrderDescription | SystemOption->ProposedWorkOrderDescription | string (Allowed values: [TaskSummaryOnly, TaskSummaryAndDescription, TaskDescriptionOnly]) | enum |\r\n| proposedWorkOrderScheduledWorkOrderStatusId | SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Id | integer | int64 |\r\n| proposedWorkOrderScheduledWorkOrderStatusCode | SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Code | string | |\r\n| proposedWorkOrderScheduledWorkOrderStatusDescription | SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Description | string | |\r\n| proposedWorkOrdersFutureRange | SystemOption->ProposedWorkOrdersFutureRange | integer | int32 |\r\n| scheduledWorkOrderCodePrefix | SystemOption->ScheduledWorkOrderCodePrefix | string | |\r\n| standardTaskAddedCustomised | SystemOption->StandardTaskAddedCustomised | boolean | |\r\n| startOnDateCustomised | SystemOption->StartOnDateCustomised | boolean | |\r\n| taskImportanceWeight | SystemOption->TaskImportanceWeight | number | decimal |\r\n| typeOfWorkReadOnlyCustomised | SystemOption->TypeOfWorkReadOnlyCustomised | boolean | |\r\n| unscheduledWorkOrderCodePrefix | SystemOption->UnscheduledWorkOrderCodePrefix | string | |\r\n| validateWorkOrderTaskCompletedReason | SystemOption->ValidateWorkOrderTaskCompletedReason | string (Allowed values: [MandatoryTasks, AllTasks]) | enum |\r\n| verifyOutstandingDelayedSideEffects | SystemOption->VerifyOutstandingDelayedSideEffects | boolean | |\r\n| workOrderCodeLength | SystemOption->WorkOrderCodeLength | integer | int32 |\r\n| workOrderCodeReadOnlyCustomised | SystemOption->WorkOrderCodeReadOnlyCustomised | boolean | |\r\n| workOrderImportanceWeight | SystemOption->WorkOrderImportanceWeight | number | decimal |\r\n| workOrderMeterScheduledReadingMaintain | SystemOption->WorkOrderMeterScheduledReadingMaintain | boolean | |\r\n| workOrderMeterScheduledReadingMethod | SystemOption->WorkOrderMeterScheduledReadingMethod | string (Allowed values: [Highest, Lowest]) | enum |\r\n| workOrderTaskAutomaticallyCreateMeterReading | SystemOption->WorkOrderTaskAutomaticallyCreateMeterReading | boolean | |\r\n| workOrderTaskResourceAutomaticallyAssignResource | SystemOption->WorkOrderTaskResourceAutomaticallyAssignResource | boolean | |\r\n| workPerformedEditableBaseStatus | SystemOption->WorkPerformedEditableBaseStatus | string (Allowed values: [Approved, ApprovedAndCompleted]) | enum |\r\n| workPerformedRequiredCustomised | SystemOption->WorkPerformedRequiredCustomised | boolean | |\r\n| workRequestCodeLength | SystemOption->WorkRequestCodeLength | integer | int32 |\r\n| workRequestCodePrefix | SystemOption->WorkRequestCodePrefix | string | |\r\n| workRequestUseIdAsCode | SystemOption->WorkRequestUseIdAsCode | boolean | |\r\n", "operationId": "GetSystemOption", "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 System Option", "schema": { "$ref": "#/definitions/GetSystemOptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option" ], "summary": "Update an existing System Option resource.", "description": "### Request Body\r\n#### 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 | SystemOption->Version | integer | int32 |\r\n| companyName | SystemOption->CompanyName | string | |\r\n| allowDuplicateTaskLabour | SystemOption->AllowDuplicateTaskLabour | boolean | |\r\n| allowDuplicateTaskSpares | SystemOption->AllowDuplicateTaskSpares | boolean | |\r\n| alwaysAllowMultipleOptionValues | SystemOption->AlwaysAllowMultipleOptionValues | boolean | |\r\n| alignAssetTasksAfterMeterReset | SystemOption->AlignAssetTasksAfterMeterReset | boolean | |\r\n| validateAverageDailyRateVariancePercentage | SystemOption->ValidateAverageDailyRateVariancePercentage | boolean | |\r\n| averageDailyRateVariancePercentage | SystemOption->AverageDailyRateVariancePercentage | number | decimal |\r\n| allowCaseSensitiveCodeFields | SystemOption->AllowCaseSensitiveCodeFields | boolean | |\r\n| autoUpperCaseCodes | SystemOption->AutoUpperCaseCodes | boolean | |\r\n| contentTranslate | SystemOption->ContentTranslate | boolean | |\r\n| dateFormat | SystemOption->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | SystemOption->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultCreateSaveAction | SystemOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | SystemOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| defaultLanguageId | SystemOption->DefaultLanguage_Id | integer | int64 |\r\n| defaultPageLimit | SystemOption->DefaultPageLimit | integer | int32 |\r\n| defaultTradeLookup | SystemOption->DefaultTradeLookup | string (Allowed values: [AllTrades, SectionTrades]) | enum |\r\n| defaultFirstWeekOfTheYear | SystemOption->DefaultFirstWeekOfTheYear | string (Allowed values: [StartsOnJan1, First4DayWeek, FirstFullWeek]) | enum |\r\n| displayMultipleCurrencyFields | SystemOption->DisplayMultipleCurrencyFields | boolean | |\r\n| reportServerReportLanguage | SystemOption->ReportServerReportLanguage | string | |\r\n| reportServerUILanguage | SystemOption->ReportServerUILanguage | string | |\r\n| synchroniseSiteTreeWithPermissionTree | SystemOption->SynchroniseSiteTreeWithPermissionTree | boolean | |\r\n| defaultAssetTypeDevelopmentStatusApplyToChildren | SystemOption->DefaultAssetTypeDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultAssetTypeDevelopmentStatusApplyToDescendants | SystemOption->DefaultAssetTypeDevelopmentStatusApplyToDescendants | boolean | |\r\n| defaultAssetDevelopmentStatusApplyToChildren | SystemOption->DefaultAssetDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultSyncDevelopmentStatusApplyToChildren | SystemOption->DefaultSyncDevelopmentStatusApplyToChildren | boolean | |\r\n| defaultIsActiveApplyToChildren | SystemOption->DefaultIsActiveApplyToChildren | boolean | |\r\n| defaultIsActiveApplyToDescendants | SystemOption->DefaultIsActiveApplyToDescendants | boolean | |\r\n| defaultIsActiveApplyToDetails | SystemOption->DefaultIsActiveApplyToDetails | boolean | |\r\n| timeFormat | SystemOption->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| supportPerson | SystemOption->SupportPerson | string | |\r\n| supportPhoneNumber | SystemOption->SupportPhoneNumber | string | |\r\n| supportEmail | SystemOption->SupportEmail | string | |\r\n| enableCosting | SystemOption->EnableCosting | boolean | |\r\n| allowContractorItems | SystemOption->AllowContractorItems | boolean | |\r\n| allowDirectPurchaseItems | SystemOption->AllowDirectPurchaseItems | boolean | |\r\n| allowNoLabourFeedbackOnClosedWorkOrders | SystemOption->AllowNoLabourFeedbackOnClosedWorkOrders | boolean | |\r\n| allowTaskSpareDeletes | SystemOption->AllowTaskSpareDeletes | boolean | |\r\n| autoCalculateEstimatedDowntimeForFollowUpWorkOrders | SystemOption->AutoCalculateEstimatedDowntimeForFollowUpWorkOrders | boolean | |\r\n| autoCalculateEstimatedDowntimeForManualWorkOrders | SystemOption->AutoCalculateEstimatedDowntimeForManualWorkOrders | boolean | |\r\n| autoCalculateEstimatedDowntimeForScheduledWorkOrders | SystemOption->AutoCalculateEstimatedDowntimeForScheduledWorkOrders | boolean | |\r\n| autoCalculateEstimatedDurationForFollowUpWorkOrders | SystemOption->AutoCalculateEstimatedDurationForFollowUpWorkOrders | boolean | |\r\n| autoCalculateEstimatedDurationForManualWorkOrders | SystemOption->AutoCalculateEstimatedDurationForManualWorkOrders | boolean | |\r\n| autoCalculateEstimatedDurationForScheduledWorkOrders | SystemOption->AutoCalculateEstimatedDurationForScheduledWorkOrders | boolean | |\r\n| autoUpdateCompletedOnDate | SystemOption->AutoUpdateCompletedOnDate | boolean | |\r\n| checkStatusChangeWhenComplete | SystemOption->CheckStatusChangeWhenComplete | boolean | |\r\n| combineResourcesOnSingleTask | SystemOption->CombineResourcesOnSingleTask | string (Allowed values: [AlwaysAsk, Always, Never]) | enum |\r\n| contractorItemsCodesMandatory | SystemOption->ContractorItemsCodesMandatory | boolean | |\r\n| defaultStatusId | SystemOption->DefaultStatus_Id | integer | int64 |\r\n| dueCalendarTasksLookBackPeriod | SystemOption->DueCalendarTasksLookBackPeriod | string | duration |\r\n| dueTasksFutureRange | SystemOption->DueTasksFutureRange | integer | int32 |\r\n| failureAnalysisCustomised | SystemOption->FailureAnalysisCustomised | boolean | |\r\n| followUpTaskResponsibility | SystemOption->FollowUpTaskResponsibility | string (Allowed values: [FollowUpAssetTaskResponsibility, SourceWorkOrderResponsibility]) | enum |\r\n| followUpWorkOrderCatchStatus | SystemOption->FollowUpWorkOrderCatchStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| followUpWorkOrderCustomised | SystemOption->FollowUpWorkOrderCustomised | boolean | |\r\n| followUpWorkOrderTasksGroupBySection | SystemOption->FollowUpWorkOrderTasksGroupBySection | boolean | |\r\n| followUpWorkOrderTasksGroupByTrade | SystemOption->FollowUpWorkOrderTasksGroupByTrade | boolean | |\r\n| followUpWorkOrderTypeOfWorkId | SystemOption->FollowUpWorkOrderTypeOfWork_Id | integer | int64 |\r\n| labourRequiredCustomised | SystemOption->LabourRequiredCustomised | boolean | |\r\n| mandatoryTasksCustomised | SystemOption->MandatoryTasksCustomised | boolean | |\r\n| mergeAndSplitCancelledWorkOrderStatusId | SystemOption->MergeAndSplitCancelledWorkOrderStatus_Id | integer | int64 |\r\n| applySuppressionOnSplitAndMergeAction | SystemOption->ApplySuppressionOnSplitAndMergeAction | boolean | |\r\n| mergeAndSplitInformationOnWorkOrder | SystemOption->MergeAndSplitInformationOnWorkOrder | boolean | |\r\n| permitNumberCustomised | SystemOption->PermitNumberCustomised | boolean | |\r\n| predictedMeterReadingsLookBackPeriod | SystemOption->PredictedMeterReadingsLookBackPeriod | string | duration |\r\n| proposedWorkDefaultGroupingInterval | SystemOption->ProposedWorkDefaultGroupingInterval | integer | int32 |\r\n| proposedWorkDefaultTaskGroupingStartDate | SystemOption->ProposedWorkDefaultTaskGroupingStartDate | string | date-time |\r\n| proposedWorkOrderDescription | SystemOption->ProposedWorkOrderDescription | string (Allowed values: [TaskSummaryOnly, TaskSummaryAndDescription, TaskDescriptionOnly]) | enum |\r\n| proposedWorkOrderScheduledWorkOrderStatusId | SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Id | integer | int64 |\r\n| proposedWorkOrdersFutureRange | SystemOption->ProposedWorkOrdersFutureRange | integer | int32 |\r\n| scheduledWorkOrderCodePrefix | SystemOption->ScheduledWorkOrderCodePrefix | string | |\r\n| standardTaskAddedCustomised | SystemOption->StandardTaskAddedCustomised | boolean | |\r\n| typeOfWorkReadOnlyCustomised | SystemOption->TypeOfWorkReadOnlyCustomised | boolean | |\r\n| unscheduledWorkOrderCodePrefix | SystemOption->UnscheduledWorkOrderCodePrefix | string | |\r\n| validateWorkOrderTaskCompletedReason | SystemOption->ValidateWorkOrderTaskCompletedReason | string (Allowed values: [MandatoryTasks, AllTasks]) | enum |\r\n| verifyOutstandingDelayedSideEffects | SystemOption->VerifyOutstandingDelayedSideEffects | boolean | |\r\n| workOrderCodeLength | SystemOption->WorkOrderCodeLength | integer | int32 |\r\n| workRequestCodePrefix | SystemOption->WorkRequestCodePrefix | string | |\r\n| workRequestCodeLength | SystemOption->WorkRequestCodeLength | integer | int32 |\r\n| workRequestUseIdAsCode | SystemOption->WorkRequestUseIdAsCode | boolean | |\r\n| workOrderCodeReadOnlyCustomised | SystemOption->WorkOrderCodeReadOnlyCustomised | boolean | |\r\n| workOrderMeterScheduledReadingMaintain | SystemOption->WorkOrderMeterScheduledReadingMaintain | boolean | |\r\n| calculateScheduledMetersFieldOnWorkOrders | SystemOption->CalculateScheduledMetersFieldOnWorkOrders | boolean | |\r\n| workOrderMeterScheduledReadingMethod | SystemOption->WorkOrderMeterScheduledReadingMethod | string (Allowed values: [Highest, Lowest]) | enum |\r\n| workOrderTaskAutomaticallyCreateMeterReading | SystemOption->WorkOrderTaskAutomaticallyCreateMeterReading | boolean | |\r\n| workOrderTaskResourceAutomaticallyAssignResource | SystemOption->WorkOrderTaskResourceAutomaticallyAssignResource | boolean | |\r\n| workPerformedEditableBaseStatus | SystemOption->WorkPerformedEditableBaseStatus | string (Allowed values: [Approved, ApprovedAndCompleted]) | enum |\r\n| workPerformedRequiredCustomised | SystemOption->WorkPerformedRequiredCustomised | boolean | |\r\n| mergeAllowedWorkOrderStatus | SystemOption->MergeAllowedWorkOrderStatus | string (Allowed values: [AwaitingApproval, Approved, AwaitingApprovalOrApproved]) | enum |\r\n| mergeTypeOfWorkOption | SystemOption->MergeTypeOfWorkOption | string (Allowed values: [NoRestriction, TypeOfWorkClass, TypeOfWork]) | enum |\r\n| baseCurrencyId | SystemOption->BaseCurrency_Id | integer | int64 |\r\n| defaultWorkRequestAwaitingApprovalStatusId | SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Id | integer | int64 |\r\n| defaultWorkRequestClosedStatusId | SystemOption->DefaultWorkRequestClosedStatus_Id | integer | int64 |\r\n| defaultWorkRequestCancelledStatusId | SystemOption->DefaultWorkRequestCancelledStatus_Id | integer | int64 |\r\n| allowIssuingOnClosedRequisition | SystemOption->AllowIssuingOnClosedRequisition | boolean | |\r\n| allowStockAndNonStockOnTheSameRequisition | SystemOption->AllowStockAndNonStockOnTheSameRequisition | boolean | |\r\n| autoCreateRequisitionsOnScheduledWorkOrders | SystemOption->AutoCreateRequisitionsOnScheduledWorkOrders | boolean | |\r\n| defaultNewRequisitionStatusId | SystemOption->DefaultNewRequisitionStatus_Id | integer | int64 |\r\n| defaultRequisitionStatusWhenIssuedToCompletionId | SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Id | integer | int64 |\r\n| mergeSparesOnDuplicateAssetTasks | SystemOption->MergeSparesOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSparesOnDuplicateStandardTasks | SystemOption->MergeSparesOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeResourcesOnDuplicateAssetTasks | SystemOption->MergeResourcesOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeResourcesOnDuplicateStandardTasks | SystemOption->MergeResourcesOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSubTasksOnDuplicateAssetTasks | SystemOption->MergeSubTasksOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSubTasksOnDuplicateStandardTasks | SystemOption->MergeSubTasksOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| enableRequisitions | SystemOption->EnableRequisitions | boolean | |\r\n| enableRequisitionApprovalWorkflow | SystemOption->EnableRequisitionApprovalWorkflow | boolean | |\r\n| requisitionCodeLength | SystemOption->RequisitionCodeLength | integer | int32 |\r\n| requisitionCodePrefix | SystemOption->RequisitionCodePrefix | string | |\r\n| useUserRequisitionLimits | SystemOption->UseUserRequisitionLimits | boolean | |\r\n| defaultResourceDurationUnitOfMeasurement | SystemOption->DefaultResourceDurationUnitOfMeasurement | integer | int64 |\r\n| allowWorkOrdersWithoutAssets | SystemOption->AllowWorkOrdersWithoutAssets | boolean | |\r\n| enableSla | SystemOption->EnableSla | boolean | |\r\n| autoPopulateStartOnAndCompleteByDates | SystemOption->AutoPopulateStartOnAndCompleteByDates | boolean | |\r\n| startOnDateCustomised | SystemOption->StartOnDateCustomised | boolean | |\r\n| completeByDateCustomised | SystemOption->CompleteByDateCustomised | boolean | |\r\n| priorityBasedOn | SystemOption->PriorityBasedOn | string (Allowed values: [HighestWorkOrderTaskPriority, LowestWorkOrderTaskPriority]) | enum |\r\n| assetImportanceWeight | SystemOption->AssetImportanceWeight | number | decimal |\r\n| workOrderImportanceWeight | SystemOption->WorkOrderImportanceWeight | number | decimal |\r\n| taskImportanceWeight | SystemOption->TaskImportanceWeight | number | decimal |\r\n| enforceAssetWarranty | SystemOption->EnforceAssetWarranty | 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| companyName | Nullable | False | |\r\n| companyName | Min Length | >= 1 chars| |\r\n| companyName | Max Length | <= 100 chars| |\r\n| averageDailyRateVariancePercentage | Min Value | >= 0| |\r\n| dateFormat | Nullable | False | |\r\n| dateSeparator | Nullable | False | |\r\n| defaultPageLimit | Min Value | > 0| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| timeFormat | Nullable | False | |\r\n| supportPerson | Min Length | >= 1 chars| |\r\n| supportPerson | Max Length | <= 100 chars| |\r\n| supportPhoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| supportPhoneNumber | Min Length | >= 1 chars| |\r\n| supportPhoneNumber | Max Length | <= 30 chars| |\r\n| supportEmail | Max Length | <= 255 chars| |\r\n| defaultStatusId | Nullable | False | |\r\n| followUpWorkOrderTypeOfWorkId | Nullable | False | |\r\n| scheduledWorkOrderCodePrefix | Nullable | False | |\r\n| scheduledWorkOrderCodePrefix | Min Length | >= 1 chars| |\r\n| scheduledWorkOrderCodePrefix | Max Length | <= 10 chars| |\r\n| unscheduledWorkOrderCodePrefix | Nullable | False | |\r\n| unscheduledWorkOrderCodePrefix | Min Length | >= 1 chars| |\r\n| unscheduledWorkOrderCodePrefix | Max Length | <= 10 chars| |\r\n| workOrderCodeLength | Min Value | >= 5| |\r\n| workOrderCodeLength | Max Value | <= 50| |\r\n| workRequestCodePrefix | Max Length | <= 10 chars| |\r\n| workRequestCodeLength | Min Value | >= 4| |\r\n| workRequestCodeLength | Max Value | <= 50| |\r\n| baseCurrencyId | Nullable | False | |\r\n| requisitionCodeLength | Min Value | >= 4| |\r\n| requisitionCodeLength | Max Value | <= 50| |\r\n| requisitionCodePrefix | Max Length | <= 10 chars| |\r\n| priorityBasedOn | Nullable | False | |\r\n| assetImportanceWeight | Nullable | False | |\r\n| workOrderImportanceWeight | Nullable | False | |\r\n| taskImportanceWeight | Nullable | False | |\r\n\r\n", "operationId": "UpdateSystemOption", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSystemOptionResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Modules/WM": { "get": { "tags": [ "System Option" ], "summary": "Get the subset of WM module options for the System Option 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 | SystemOption->Id | integer | int64 |\r\n| version | SystemOption->Version | integer | int32 |\r\n| allowDirectPurchaseItems | SystemOption->AllowDirectPurchaseItems | boolean | |\r\n| allowContractorItems | SystemOption->AllowContractorItems | boolean | |\r\n| contractorItemsCodesMandatory | SystemOption->ContractorItemsCodesMandatory | boolean | |\r\n| allowTaskSpareDeletes | SystemOption->AllowTaskSpareDeletes | boolean | |\r\n| autoUpdateCompletedOnDate | SystemOption->AutoUpdateCompletedOnDate | boolean | |\r\n| startOnDateCustomised | SystemOption->StartOnDateCustomised | boolean | |\r\n| completeByDateCustomised | SystemOption->CompleteByDateCustomised | boolean | |\r\n| defaultStatusId | SystemOption->DefaultStatus_Id | integer | int64 |\r\n| scheduledWorkOrderCodePrefix | SystemOption->ScheduledWorkOrderCodePrefix | string | |\r\n| unscheduledWorkOrderCodePrefix | SystemOption->UnscheduledWorkOrderCodePrefix | string | |\r\n| workOrderCodeLength | SystemOption->WorkOrderCodeLength | integer | int32 |\r\n| workRequestCodeLength | SystemOption->WorkRequestCodeLength | integer | int32 |\r\n| workRequestCodePrefix | SystemOption->WorkRequestCodePrefix | string | |\r\n| workRequestUseIdAsCode | SystemOption->WorkRequestUseIdAsCode | boolean | |\r\n| failureAnalysisCustomised | SystemOption->FailureAnalysisCustomised | boolean | |\r\n| workOrderTaskResourceAutomaticallyAssignResource | SystemOption->WorkOrderTaskResourceAutomaticallyAssignResource | boolean | |\r\n| workPerformedEditableBaseStatus | SystemOption->WorkPerformedEditableBaseStatus | string (Allowed values: [Approved, ApprovedAndCompleted]) | enum |\r\n| followUpWorkOrderTasksGroupBySection | SystemOption->FollowUpWorkOrderTasksGroupBySection | boolean | |\r\n| mandatoryTasksCustomised | SystemOption->MandatoryTasksCustomised | boolean | |\r\n| followUpWorkOrderCustomised | SystemOption->FollowUpWorkOrderCustomised | boolean | |\r\n| followUpWorkOrderTypeOfWorkId | SystemOption->FollowUpWorkOrderTypeOfWork_Id | integer | int64 |\r\n| typeOfWorkReadOnlyCustomised | SystemOption->TypeOfWorkReadOnlyCustomised | boolean | |\r\n| workOrderCodeReadOnlyCustomised | SystemOption->WorkOrderCodeReadOnlyCustomised | boolean | |\r\n| labourRequiredCustomised | SystemOption->LabourRequiredCustomised | boolean | |\r\n| standardTaskAddedCustomised | SystemOption->StandardTaskAddedCustomised | boolean | |\r\n| permitNumberCustomised | SystemOption->PermitNumberCustomised | boolean | |\r\n| followUpWorkOrderTasksGroupByTrade | SystemOption->FollowUpWorkOrderTasksGroupByTrade | boolean | |\r\n| followUpWorkOrderCatchStatus | SystemOption->FollowUpWorkOrderCatchStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| mergeAndSplitCancelledWorkOrderStatusId | SystemOption->MergeAndSplitCancelledWorkOrderStatus_Id | integer | int64 |\r\n| mergeSparesOnDuplicateAssetTasks | SystemOption->MergeSparesOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSparesOnDuplicateStandardTasks | SystemOption->MergeSparesOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeResourcesOnDuplicateAssetTasks | SystemOption->MergeResourcesOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeResourcesOnDuplicateStandardTasks | SystemOption->MergeResourcesOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSubTasksOnDuplicateAssetTasks | SystemOption->MergeSubTasksOnDuplicateAssetTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| mergeSubTasksOnDuplicateStandardTasks | SystemOption->MergeSubTasksOnDuplicateStandardTasks | string (Allowed values: [Always, Never, OnlyWhenDifferent]) | enum |\r\n| applySuppressionOnSplitAndMergeAction | SystemOption->ApplySuppressionOnSplitAndMergeAction | boolean | |\r\n| mergeAndSplitInformationOnWorkOrder | SystemOption->MergeAndSplitInformationOnWorkOrder | boolean | |\r\n| workOrderTaskAutomaticallyCreateMeterReading | SystemOption->WorkOrderTaskAutomaticallyCreateMeterReading | boolean | |\r\n| proposedWorkOrderScheduledWorkOrderStatusId | SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Id | integer | int64 |\r\n| followUpTaskResponsibility | SystemOption->FollowUpTaskResponsibility | string (Allowed values: [FollowUpAssetTaskResponsibility, SourceWorkOrderResponsibility]) | enum |\r\n| proposedWorkOrderDescription | SystemOption->ProposedWorkOrderDescription | string (Allowed values: [TaskSummaryOnly, TaskSummaryAndDescription, TaskDescriptionOnly]) | enum |\r\n| combineResourcesOnSingleTask | SystemOption->CombineResourcesOnSingleTask | string (Allowed values: [AlwaysAsk, Always, Never]) | enum |\r\n| dueTasksFutureRange | SystemOption->DueTasksFutureRange | integer | int32 |\r\n| proposedWorkOrdersFutureRange | SystemOption->ProposedWorkOrdersFutureRange | integer | int32 |\r\n| predictedMeterReadingsLookBackPeriod | SystemOption->PredictedMeterReadingsLookBackPeriod | string | duration |\r\n| dueCalendarTasksLookBackPeriod | SystemOption->DueCalendarTasksLookBackPeriod | string | duration |\r\n| proposedWorkDefaultGroupingInterval | SystemOption->ProposedWorkDefaultGroupingInterval | integer | int32 |\r\n| proposedWorkDefaultTaskGroupingStartDate | SystemOption->ProposedWorkDefaultTaskGroupingStartDate | string | date-time |\r\n| validateWorkOrderTaskCompletedReason | SystemOption->ValidateWorkOrderTaskCompletedReason | string (Allowed values: [MandatoryTasks, AllTasks]) | enum |\r\n| workPerformedRequiredCustomised | SystemOption->WorkPerformedRequiredCustomised | boolean | |\r\n| defaultWorkRequestAwaitingApprovalStatusId | SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Id | integer | int64 |\r\n| defaultWorkRequestClosedStatusId | SystemOption->DefaultWorkRequestClosedStatus_Id | integer | int64 |\r\n| defaultWorkRequestCancelledStatusId | SystemOption->DefaultWorkRequestCancelledStatus_Id | integer | int64 |\r\n| enforceAssetWarranty | SystemOption->EnforceAssetWarranty | boolean | |\r\n", "operationId": "GetSystemOptionWMModule", "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 System Option", "schema": { "$ref": "#/definitions/GetSystemOptionWMModuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ActiveTypesOfWork": { "get": { "tags": [ "System Option" ], "summary": "Get a collection of all the Active Type of Work resources for setting up System Option validations.", "description": "### Response Body\r\n#### Payload\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| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "GetAllActiveTypeOfWorkCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option collection", "schema": { "$ref": "#/definitions/GetAllActiveTypeOfWorkCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ActiveStatuses": { "get": { "tags": [ "System Option" ], "summary": "Get a collection of all the Active Work Order Status resources for setting up System Option validations.", "description": "### Response Body\r\n#### Payload\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| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n", "operationId": "GetAllActiveWorkOrderStatusCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option collection", "schema": { "$ref": "#/definitions/GetAllActiveWorkOrderStatusCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/TypesOfWork": { "get": { "tags": [ "System Option" ], "summary": "Get a collection of all the Type of Work resources for setting up System Option validations.", "description": "### Response Body\r\n#### Payload\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| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n", "operationId": "GetAllTypeOfWorkCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option collection", "schema": { "$ref": "#/definitions/GetAllTypeOfWorkCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Statuses": { "get": { "tags": [ "System Option" ], "summary": "Get a collection of all the Work Order Status resources for setting up System Option validations.", "description": "### Response Body\r\n#### Payload\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| applyStatusRestrictions | WorkOrderStatus->ApplyStatusRestrictions | boolean | |\r\n", "operationId": "GetAllWorkOrderStatusCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option collection", "schema": { "$ref": "#/definitions/GetAllWorkOrderStatusCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupSystemOptionBaseCurrency": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Currency for the System Option.", "description": "### Response Body\r\n#### Payload\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": "LookupSystemOptionBaseCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/SystemOptionBaseCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupSystemOptionDefaultLanguage": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Language for the System Option.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Language->Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n", "operationId": "LookupSystemOptionDefaultLanguage", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Language collection", "schema": { "$ref": "#/definitions/SystemOptionDefaultLanguageLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupMMModuleOptionDefaultNewRequisitionStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Requisition 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 | RequisitionStatus->Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n", "operationId": "LookupMMModuleOptionDefaultNewRequisitionStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Status collection", "schema": { "$ref": "#/definitions/MMModuleOptionDefaultNewRequisitionStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupMMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletion": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Requisition 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 | RequisitionStatus->Id | integer | int64 |\r\n| code | RequisitionStatus->Code | string | |\r\n| description | RequisitionStatus->Description | string | |\r\n| baseStatus | RequisitionStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled, AwaitingApprovalWorkflow]) | enum |\r\n", "operationId": "LookupMMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletion", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Status collection", "schema": { "$ref": "#/definitions/MMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionDefaultWorkOrderStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup 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 | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n", "operationId": "LookupWMModuleOptionDefaultWorkOrderStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionDefaultWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionDefaultWorkRequestAwaitingApprovalStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup the default Work Request Awaiting Approval Pragma.OnKey.WM.WorkRequestStatuses.WorkRequestStatus.", "description": "### Response Body\r\n#### Payload\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": "LookupWMModuleOptionDefaultWorkRequestAwaitingApprovalStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionDefaultWorkRequestAwaitingApprovalStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionDefaultWorkRequestCancelledStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup the default Work Request Cancelled Pragma.OnKey.WM.WorkRequestStatuses.WorkRequestStatus.", "description": "### Response Body\r\n#### Payload\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": "LookupWMModuleOptionDefaultWorkRequestCancelledStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionDefaultWorkRequestCancelledStatusLookupResourceResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionDefaultWorkRequestClosedStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup the default Work Request Closed Pragma.OnKey.WM.WorkRequestStatuses.WorkRequestStatus.", "description": "### Response Body\r\n#### Payload\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": "LookupWMModuleOptionDefaultWorkRequestClosedStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionDefaultWorkRequestClosedStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionFollowUpWorkOrderTypeOfWork": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Type of Work for the System Option.", "description": "### Response Body\r\n#### Payload\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": "LookupWMModuleOptionFollowUpWorkOrderTypeOfWork", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionFollowUpWorkOrderTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionMergeAndSplitCancelledWorkOrderStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Work Order Merge Cancelled Pragma.OnKey.WM.WorkOrderStatuses.WorkOrderStatus.", "description": "### Response Body\r\n#### Payload\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": "LookupWMModuleOptionMergeAndSplitCancelledWorkOrderStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionMergeAndSplitCancelledWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Lookups/LookupWMModuleOptionProposedWorkOrderScheduledWorkOrderStatus": { "get": { "tags": [ "System Option" ], "summary": "Lookup the Proposed Work Order Pragma.OnKey.WM.WorkOrderStatuses.WorkOrderStatus.", "description": "### Response Body\r\n#### Payload\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": "LookupWMModuleOptionProposedWorkOrderScheduledWorkOrderStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionProposedWorkOrderScheduledWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/DefaultStandardTasks/{id}": { "get": { "tags": [ "System Option Default Standard Task" ], "summary": "Get a System Option Default Standard 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 | SystemOptionDefaultStandardTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionDefaultStandardTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionDefaultStandardTask->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionDefaultStandardTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionDefaultStandardTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionDefaultStandardTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionDefaultStandardTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionDefaultStandardTask->ModifiedOn | string | date-time |\r\n| version | SystemOptionDefaultStandardTask->Version | integer | int32 |\r\n| id | SystemOptionDefaultStandardTask->Id | integer | int64 |\r\n| systemOptionId | SystemOptionDefaultStandardTask->SystemOption_Id | integer | int64 |\r\n| standardTaskId | SystemOptionDefaultStandardTask->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | SystemOptionDefaultStandardTask->StandardTask_Code | string | |\r\n| standardTaskDescription | SystemOptionDefaultStandardTask->StandardTask_Description | string | |\r\n", "operationId": "GetSystemOptionDefaultStandardTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Default Standard Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Default Standard Task", "schema": { "$ref": "#/definitions/GetSystemOptionDefaultStandardTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "System Option Default Standard Task" ], "summary": "Delete an existing System Option Default Standard 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 | SystemOptionDefaultStandardTask->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": "DeleteSystemOptionDefaultStandardTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Default Standard Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionDefaultStandardTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Default Standard 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/SYSTEM/Options/DefaultStandardTasks": { "get": { "tags": [ "System Option Default Standard Task" ], "summary": "Get a collection of System Option Default Standard 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 | SystemOptionDefaultStandardTask->Id | integer | int64 |\r\n| version | SystemOptionDefaultStandardTask->Version | integer | int32 |\r\n| standardTaskId | SystemOptionDefaultStandardTask->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | SystemOptionDefaultStandardTask->StandardTask_Code | string | |\r\n| standardTaskDescription | SystemOptionDefaultStandardTask->StandardTask_Description | string | |\r\n| standardTaskSequenceNumber | SystemOptionDefaultStandardTask->StandardTask_SequenceNumber | integer | int32 |\r\n| standardTaskIsInspection | SystemOptionDefaultStandardTask->StandardTask_IsInspection | boolean | |\r\n| standardTaskImportanceDescription | SystemOptionDefaultStandardTask->StandardTask_Importance_Description | string | |\r\n| standardTaskTypeOfWorkDescription | SystemOptionDefaultStandardTask->StandardTask_TypeOfWork_Description | string | |\r\n| standardTaskIntervalType1Description | SystemOptionDefaultStandardTask->StandardTask_IntervalType1_Description | string | |\r\n| standardTaskDefaultInterval1Description | SystemOptionDefaultStandardTask->StandardTask_DefaultInterval1_Description | string | |\r\n| standardTaskIntervalType2Description | SystemOptionDefaultStandardTask->StandardTask_IntervalType2_Description | string | |\r\n| standardTaskDefaultInterval2Description | SystemOptionDefaultStandardTask->StandardTask_DefaultInterval2_Description | string | |\r\n", "operationId": "GetSystemOptionDefaultStandardTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable System Option Default Standard Task collection", "schema": { "$ref": "#/definitions/GetSystemOptionDefaultStandardTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Default Standard Task" ], "summary": "Create a new System Option Default Standard 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| standardTaskId | SystemOptionDefaultStandardTask->StandardTask_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| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionDefaultStandardTask", "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/CreateSystemOptionDefaultStandardTaskResourceActionRequest" } }, { "$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/SYSTEM/Options/DefaultStandardTasks/Lookups/LookupWMModuleOptionDefaultStandardTaskStandardTask": { "get": { "tags": [ "System Option Default Standard Task" ], "summary": "Lookup the Standard Task for the System Option Default Standard 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", "operationId": "LookupWMModuleOptionDefaultStandardTaskStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WMModuleOptionDefaultStandardTaskStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/DefaultStandardTasks/Batch/{ids}": { "get": { "tags": [ "System Option Default Standard Task" ], "summary": "Get a collection of System Option Default Standard 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 | SystemOptionDefaultStandardTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionDefaultStandardTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionDefaultStandardTask->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionDefaultStandardTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionDefaultStandardTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionDefaultStandardTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionDefaultStandardTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionDefaultStandardTask->ModifiedOn | string | date-time |\r\n| version | SystemOptionDefaultStandardTask->Version | integer | int32 |\r\n| id | SystemOptionDefaultStandardTask->Id | integer | int64 |\r\n| systemOptionId | SystemOptionDefaultStandardTask->SystemOption_Id | integer | int64 |\r\n| standardTaskId | SystemOptionDefaultStandardTask->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | SystemOptionDefaultStandardTask->StandardTask_Code | string | |\r\n| standardTaskDescription | SystemOptionDefaultStandardTask->StandardTask_Description | string | |\r\n", "operationId": "BatchGetSystemOptionDefaultStandardTask", "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 System Option Default Standard 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 System Option Default Standard Task collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionDefaultStandardTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/DefaultStandardTasks/Batch": { "post": { "tags": [ "System Option Default Standard Task" ], "summary": "Create a new collection of System Option Default Standard 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| standardTaskId | SystemOptionDefaultStandardTask->StandardTask_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| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionDefaultStandardTask", "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/BatchCreateSystemOptionDefaultStandardTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Default Standard 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" } } }, "delete": { "tags": [ "System Option Default Standard Task" ], "summary": "Delete a collection of existing System Option Default Standard 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 | SystemOptionDefaultStandardTask->Id | integer | int64 |\r\n| version | SystemOptionDefaultStandardTask->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": "BatchDeleteSystemOptionDefaultStandardTask", "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/BatchDeleteSystemOptionDefaultStandardTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Default Standard 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/SYSTEM/Options/FileAttachmentCategories/{id}": { "get": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Get a System Option Reference File Attachment Category resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | SystemOptionFileAttachmentCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionFileAttachmentCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionFileAttachmentCategory->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionFileAttachmentCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionFileAttachmentCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionFileAttachmentCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionFileAttachmentCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionFileAttachmentCategory->ModifiedOn | string | date-time |\r\n| version | SystemOptionFileAttachmentCategory->Version | integer | int32 |\r\n| id | SystemOptionFileAttachmentCategory->Id | integer | int64 |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id | integer | int64 |\r\n| defaultFileAttachmentCategoryCode | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Code | string | |\r\n| defaultFileAttachmentCategoryDescription | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Description | string | |\r\n| defaultFileAttachmentCategoryAutoIsRestricted | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_AutoIsRestricted | boolean | |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n| systemOptionId | SystemOptionFileAttachmentCategory->SystemOption_Id | integer | int64 |\r\n", "operationId": "GetSystemOptionFileAttachmentCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Reference File Attachment Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Reference File Attachment Category", "schema": { "$ref": "#/definitions/GetSystemOptionFileAttachmentCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Update an existing System Option Reference File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SystemOptionFileAttachmentCategory->Version | integer | int32 |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_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| entityType | Nullable | False | |\r\n| fileType | Nullable | False | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension' |\r\n| fileType | Nullable | True | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel ne 'Extension' |\r\n| defaultFileAttachmentCategoryId | Nullable | False | |\r\n\r\n", "operationId": "UpdateSystemOptionFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Reference File Attachment Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSystemOptionFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference File Attachment Category was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Delete an existing System Option Reference File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SystemOptionFileAttachmentCategory->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": "DeleteSystemOptionFileAttachmentCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Reference File Attachment Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference File Attachment Category was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/FileAttachmentCategories": { "get": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Get a collection of System Option Reference File Attachment Category resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SystemOptionFileAttachmentCategory->Id | integer | int64 |\r\n| version | SystemOptionFileAttachmentCategory->Version | integer | int32 |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id | integer | int64 |\r\n| defaultFileAttachmentCategoryCode | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Code | string | |\r\n| defaultFileAttachmentCategoryDescription | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Description | string | |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n", "operationId": "GetSystemOptionFileAttachmentCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable System Option Reference File Attachment Category collection", "schema": { "$ref": "#/definitions/GetSystemOptionFileAttachmentCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Create a new System Option Reference File Attachment Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_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| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n| fileType | Nullable | False | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension' |\r\n| fileType | Nullable | True | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel ne 'Extension' |\r\n| defaultFileAttachmentCategoryId | Required | True | |\r\n| defaultFileAttachmentCategoryId | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionFileAttachmentCategory", "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/CreateSystemOptionFileAttachmentCategoryResourceActionRequest" } }, { "$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/SYSTEM/Options/FileAttachmentCategories/Lookups/LookupDMModuleOptionAllowedFileExtension": { "get": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "System Option Reference File Attachment Category", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| extension | AllowedFileExtensionView->Extension | string | |\r\n", "operationId": "LookupDMModuleOptionAllowedFileExtension", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Allowed File Extensions collection", "schema": { "$ref": "#/definitions/DMModuleOptionAllowedFileExtensionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/FileAttachmentCategories/Batch/{ids}": { "get": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Get a collection of System Option Reference File Attachment Category resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | SystemOptionFileAttachmentCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionFileAttachmentCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionFileAttachmentCategory->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionFileAttachmentCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionFileAttachmentCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionFileAttachmentCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionFileAttachmentCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionFileAttachmentCategory->ModifiedOn | string | date-time |\r\n| version | SystemOptionFileAttachmentCategory->Version | integer | int32 |\r\n| id | SystemOptionFileAttachmentCategory->Id | integer | int64 |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id | integer | int64 |\r\n| defaultFileAttachmentCategoryCode | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Code | string | |\r\n| defaultFileAttachmentCategoryDescription | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Description | string | |\r\n| defaultFileAttachmentCategoryAutoIsRestricted | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_AutoIsRestricted | boolean | |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n| systemOptionId | SystemOptionFileAttachmentCategory->SystemOption_Id | integer | int64 |\r\n", "operationId": "BatchGetSystemOptionFileAttachmentCategory", "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 System Option Reference File Attachment Category id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Reference File Attachment Category collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionFileAttachmentCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/FileAttachmentCategories/Batch": { "post": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Create a new collection of System Option Reference File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_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| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n| fileType | Nullable | False | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension' |\r\n| fileType | Nullable | True | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel ne 'Extension' |\r\n| defaultFileAttachmentCategoryId | Required | True | |\r\n| defaultFileAttachmentCategoryId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionFileAttachmentCategory", "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/BatchCreateSystemOptionFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Reference File Attachment Category batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Update a collection of existing System Option Reference File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SystemOptionFileAttachmentCategory->Id | integer | int64 |\r\n| version | SystemOptionFileAttachmentCategory->Version | integer | int32 |\r\n| defaultFileCategoryLevel | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel | string (Allowed values: [Global, Extension]) | enum |\r\n| entityType | SystemOptionFileAttachmentCategory->EntityType | string (Allowed values: [RegularAsset, PlaceholderAsset, RegularAssetTask, InPlaceAsset, Supplier, StockItem, Requisition, RequisitionItem, Resource, WorkOrder, WorkOrderTask, WorkOrderTaskSpare, WorkRequest, ImportFile, RegularAssetType]) | enum |\r\n| fileType | SystemOptionFileAttachmentCategory->FileType | string | |\r\n| defaultFileAttachmentCategoryId | SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_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| entityType | Nullable | False | |\r\n| fileType | Nullable | False | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension' |\r\n| fileType | Nullable | True | SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel ne 'Extension' |\r\n| defaultFileAttachmentCategoryId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSystemOptionFileAttachmentCategory", "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/BatchUpdateSystemOptionFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference File Attachment Category batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "System Option Reference File Attachment Category" ], "summary": "Delete a collection of existing System Option Reference File Attachment Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SystemOptionFileAttachmentCategory->Id | integer | int64 |\r\n| version | SystemOptionFileAttachmentCategory->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": "BatchDeleteSystemOptionFileAttachmentCategory", "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/BatchDeleteSystemOptionFileAttachmentCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference File Attachment Category batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/FileAttachmentFileTypes": { "get": { "tags": [ "System Option File Attachment File Type" ], "summary": "Get the collection of System Option File Attachment File Type resources configured for the Tenant.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SystemOptionFileAttachmentFileType->Id | integer | int64 |\r\n| version | SystemOptionFileAttachmentFileType->Version | integer | int32 |\r\n| extension | SystemOptionFileAttachmentFileType->Extension | string | |\r\n| groupId | SystemOptionFileAttachmentFileType->GroupId | integer | int64 |\r\n| groupMaxFileSizeInBytes | SystemOptionFileAttachmentFileType->GroupMaxFileSizeInBytes | integer | int64 |\r\n| groupName | SystemOptionFileAttachmentFileType->GroupName | string | |\r\n| mimeType | SystemOptionFileAttachmentFileType->MimeType | string | |\r\n", "operationId": "GetSystemOptionFileAttachmentFileTypeCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option File Attachment File Type collection", "schema": { "$ref": "#/definitions/GetSystemOptionFileAttachmentFileTypeListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/PageLimits/{id}": { "get": { "tags": [ "System Option Page Limit" ], "summary": "Get a System Option Page Limit 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 | SystemOptionPageLimit->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionPageLimit->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionPageLimit->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionPageLimit->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionPageLimit->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionPageLimit->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionPageLimit->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionPageLimit->ModifiedOn | string | date-time |\r\n| version | SystemOptionPageLimit->Version | integer | int32 |\r\n| id | SystemOptionPageLimit->Id | integer | int64 |\r\n| entityType | SystemOptionPageLimit->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| pageLimit | SystemOptionPageLimit->PageLimit | integer | int32 |\r\n| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| systemOptionId | SystemOptionPageLimit->SystemOption_Id | integer | int64 |\r\n", "operationId": "GetSystemOptionPageLimit", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Page Limit Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Page Limit", "schema": { "$ref": "#/definitions/GetSystemOptionPageLimitResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option Page Limit" ], "summary": "Update an existing System Option Page Limit resource.", "description": "### Request Body\r\n#### 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 | SystemOptionPageLimit->Version | integer | int32 |\r\n| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| pageLimit | SystemOptionPageLimit->PageLimit | 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| pageLimit | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateSystemOptionPageLimit", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Page Limit Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSystemOptionPageLimitResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Page Limit 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": [ "System Option Page Limit" ], "summary": "Delete an existing System Option Page Limit resource.", "description": "### Request Body\r\n#### 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 | SystemOptionPageLimit->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": "DeleteSystemOptionPageLimit", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Page Limit Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionPageLimitResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Page Limit 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/SYSTEM/Options/PageLimits": { "get": { "tags": [ "System Option Page Limit" ], "summary": "Get a collection of System Option Page Limit 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 | SystemOptionPageLimit->Version | integer | int32 |\r\n| id | SystemOptionPageLimit->Id | integer | int64 |\r\n| entityType | SystemOptionPageLimit->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| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| pageLimit | SystemOptionPageLimit->PageLimit | integer | int32 |\r\n", "operationId": "GetSystemOptionPageLimitCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable System Option Page Limit collection", "schema": { "$ref": "#/definitions/GetSystemOptionPageLimitCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Page Limit" ], "summary": "Create a new System Option Page Limit resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | SystemOptionPageLimit->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| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| pageLimit | SystemOptionPageLimit->PageLimit | 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| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n| pageLimit | Required | True | |\r\n| pageLimit | Nullable | False | |\r\n| pageLimit | Min Value | > 0| |\r\n\r\n", "operationId": "CreateSystemOptionPageLimit", "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/CreateSystemOptionPageLimitResourceActionRequest" } }, { "$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/SYSTEM/Options/PageLimits/Lookups/LookupSystemOptionPageLimitResourceAction": { "get": { "tags": [ "System Option Page Limit" ], "summary": "System Option Page Limit", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| resourceActionName | ResourceActionSummary->ResourceActionName | string | |\r\n| moduleName | ResourceActionSummary->ModuleName | string | |\r\n| resourceName | ResourceActionSummary->ResourceName | string | |\r\n| resourceActionType | ResourceActionSummary->ResourceActionType | string | |\r\n", "operationId": "LookupSystemOptionPageLimitResourceAction", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "EntityType", "in": "query", "required": true, "description": "Filter resource actions for the Entity Type", "x-schema": { "$ref": "#/definitions/EntityType" }, "x-nullable": false, "enum": [ "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" ] }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/SystemOptionPageLimitResourceActionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/PageLimits/Batch/{ids}": { "get": { "tags": [ "System Option Page Limit" ], "summary": "Get a collection of System Option Page Limit 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 | SystemOptionPageLimit->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionPageLimit->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionPageLimit->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionPageLimit->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionPageLimit->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionPageLimit->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionPageLimit->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionPageLimit->ModifiedOn | string | date-time |\r\n| version | SystemOptionPageLimit->Version | integer | int32 |\r\n| id | SystemOptionPageLimit->Id | integer | int64 |\r\n| entityType | SystemOptionPageLimit->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| pageLimit | SystemOptionPageLimit->PageLimit | integer | int32 |\r\n| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| systemOptionId | SystemOptionPageLimit->SystemOption_Id | integer | int64 |\r\n", "operationId": "BatchGetSystemOptionPageLimit", "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 System Option Page Limit 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 System Option Page Limit collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionPageLimitResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/PageLimits/Batch": { "post": { "tags": [ "System Option Page Limit" ], "summary": "Create a new collection of System Option Page Limit resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | SystemOptionPageLimit->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| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| pageLimit | SystemOptionPageLimit->PageLimit | 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| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n| pageLimit | Required | True | |\r\n| pageLimit | Nullable | False | |\r\n| pageLimit | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateSystemOptionPageLimit", "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/BatchCreateSystemOptionPageLimitRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Page Limit 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": [ "System Option Page Limit" ], "summary": "Update a collection of existing System Option Page Limit resources.", "description": "### Request Body\r\n#### 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 | SystemOptionPageLimit->Id | integer | int64 |\r\n| version | SystemOptionPageLimit->Version | integer | int32 |\r\n| resourceAction | SystemOptionPageLimit->ResourceAction | string | |\r\n| pageLimit | SystemOptionPageLimit->PageLimit | 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| pageLimit | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateSystemOptionPageLimit", "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/BatchUpdateSystemOptionPageLimitResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Page Limit 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": [ "System Option Page Limit" ], "summary": "Delete a collection of existing System Option Page Limit resources.", "description": "### Request Body\r\n#### 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 | SystemOptionPageLimit->Id | integer | int64 |\r\n| version | SystemOptionPageLimit->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": "BatchDeleteSystemOptionPageLimit", "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/BatchDeleteSystemOptionPageLimitResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Page Limit 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/SYSTEM/Options/ReferenceDataViewPermissions/{id}": { "get": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Get a System Option Reference Data View Permission 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 | SystemOptionReferenceDataViewPermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionReferenceDataViewPermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionReferenceDataViewPermission->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionReferenceDataViewPermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionReferenceDataViewPermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionReferenceDataViewPermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionReferenceDataViewPermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionReferenceDataViewPermission->ModifiedOn | string | date-time |\r\n| version | SystemOptionReferenceDataViewPermission->Version | integer | int32 |\r\n| id | SystemOptionReferenceDataViewPermission->Id | integer | int64 |\r\n| entityType | SystemOptionReferenceDataViewPermission->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| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | string | |\r\n| systemOptionId | SystemOptionReferenceDataViewPermission->SystemOption_Id | integer | int64 |\r\n", "operationId": "GetSystemOptionReferenceDataViewPermission", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Reference Data View Permission Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Reference Data View Permission", "schema": { "$ref": "#/definitions/GetSystemOptionReferenceDataViewPermissionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Update an existing System Option Reference Data View Permission resource.", "description": "### Request Body\r\n#### 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 | SystemOptionReferenceDataViewPermission->Version | integer | int32 |\r\n| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | 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| propertyPath | Nullable | False | |\r\n\r\n", "operationId": "UpdateSystemOptionReferenceDataViewPermission", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Reference Data View Permission Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference Data View Permission 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": [ "System Option Reference Data View Permission" ], "summary": "Delete an existing System Option Reference Data View Permission resource.", "description": "### Request Body\r\n#### 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 | SystemOptionReferenceDataViewPermission->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": "DeleteSystemOptionReferenceDataViewPermission", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Reference Data View Permission Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference Data View Permission 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/SYSTEM/Options/ReferenceDataViewPermissions": { "get": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Get a collection of System Option Reference Data View Permission 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 | SystemOptionReferenceDataViewPermission->Id | integer | int64 |\r\n| version | SystemOptionReferenceDataViewPermission->Version | integer | int32 |\r\n| entityType | SystemOptionReferenceDataViewPermission->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| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | string | |\r\n", "operationId": "GetSystemOptionReferenceDataViewPermissionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable System Option Reference Data View Permission collection", "schema": { "$ref": "#/definitions/GetSystemOptionReferenceDataViewPermissionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Create a new System Option Reference Data View Permission resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | SystemOptionReferenceDataViewPermission->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| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | 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| entityType | Nullable | False | |\r\n| propertyPath | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionReferenceDataViewPermission", "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/CreateSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, { "$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/SYSTEM/Options/ReferenceDataViewPermissions/Lookups/LookupSystemOptionReferenceDataViewPermissionProperty": { "get": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Lookup the Property Path for System Option Reference Data View Permission.", "description": "### Response Body\r\n#### 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": "LookupSystemOptionReferenceDataViewPermissionProperty", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "EntityType", "in": "query", "required": true, "description": "Filter the list lookup for specific EntityType", "x-schema": { "$ref": "#/definitions/EntityType" }, "x-nullable": false, "enum": [ "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" ] }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Entity Property Metadata Summary collection", "schema": { "$ref": "#/definitions/SystemOptionReferenceDataViewPermissionPropertyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReferenceDataViewPermissions/Batch/{ids}": { "get": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Get a collection of System Option Reference Data View Permission 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 | SystemOptionReferenceDataViewPermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionReferenceDataViewPermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionReferenceDataViewPermission->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionReferenceDataViewPermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionReferenceDataViewPermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionReferenceDataViewPermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionReferenceDataViewPermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionReferenceDataViewPermission->ModifiedOn | string | date-time |\r\n| version | SystemOptionReferenceDataViewPermission->Version | integer | int32 |\r\n| id | SystemOptionReferenceDataViewPermission->Id | integer | int64 |\r\n| entityType | SystemOptionReferenceDataViewPermission->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| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | string | |\r\n| systemOptionId | SystemOptionReferenceDataViewPermission->SystemOption_Id | integer | int64 |\r\n", "operationId": "BatchGetSystemOptionReferenceDataViewPermission", "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 System Option Reference Data View Permission 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 System Option Reference Data View Permission collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionReferenceDataViewPermissionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReferenceDataViewPermissions/Batch": { "post": { "tags": [ "System Option Reference Data View Permission" ], "summary": "Create a new collection of System Option Reference Data View Permission resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | SystemOptionReferenceDataViewPermission->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| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | 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| entityType | Nullable | False | |\r\n| propertyPath | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionReferenceDataViewPermission", "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/BatchCreateSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Reference Data View Permission 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": [ "System Option Reference Data View Permission" ], "summary": "Update a collection of existing System Option Reference Data View Permission resources.", "description": "### Request Body\r\n#### 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 | SystemOptionReferenceDataViewPermission->Id | integer | int64 |\r\n| version | SystemOptionReferenceDataViewPermission->Version | integer | int32 |\r\n| propertyPath | SystemOptionReferenceDataViewPermission->PropertyPath | 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| propertyPath | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSystemOptionReferenceDataViewPermission", "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/BatchUpdateSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference Data View Permission 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": [ "System Option Reference Data View Permission" ], "summary": "Delete a collection of existing System Option Reference Data View Permission resources.", "description": "### Request Body\r\n#### 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 | SystemOptionReferenceDataViewPermission->Id | integer | int64 |\r\n| version | SystemOptionReferenceDataViewPermission->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": "BatchDeleteSystemOptionReferenceDataViewPermission", "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/BatchDeleteSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Reference Data View Permission 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/SYSTEM/Options/ReportServerEntities/{id}": { "get": { "tags": [ "System Option Report Server Entity" ], "summary": "Get a System Option Report Server Entity 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 | SystemOptionReportServerEntity->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionReportServerEntity->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionReportServerEntity->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionReportServerEntity->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionReportServerEntity->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionReportServerEntity->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionReportServerEntity->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionReportServerEntity->ModifiedOn | string | date-time |\r\n| version | SystemOptionReportServerEntity->Version | integer | int32 |\r\n| id | SystemOptionReportServerEntity->Id | integer | int64 |\r\n| categories | SystemOptionReportServerEntity->Categories | array | array |\r\n| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | string | |\r\n| entityType | SystemOptionReportServerEntity->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| systemOptionId | SystemOptionReportServerEntity->SystemOption_Id | integer | int64 |\r\n", "operationId": "GetSystemOptionReportServerEntity", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Report Server Entity Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Report Server Entity", "schema": { "$ref": "#/definitions/GetSystemOptionReportServerEntityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option Report Server Entity" ], "summary": "Update an existing System Option Report Server Entity resource.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntity->Version | integer | int32 |\r\n| categories | SystemOptionReportServerEntity->Categories | array | array |\r\n| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | 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": "UpdateSystemOptionReportServerEntity", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Report Server Entity Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSystemOptionReportServerEntityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity 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": [ "System Option Report Server Entity" ], "summary": "Delete an existing System Option Report Server Entity resource.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntity->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": "DeleteSystemOptionReportServerEntity", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Report Server Entity Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionReportServerEntityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity 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/SYSTEM/Options/ReportServerEntities": { "get": { "tags": [ "System Option Report Server Entity" ], "summary": "Get a collection of System Option Report Server Entity 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 | SystemOptionReportServerEntity->Version | integer | int32 |\r\n| id | SystemOptionReportServerEntity->Id | integer | int64 |\r\n| entityType | SystemOptionReportServerEntity->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| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | string | |\r\n| categories | SystemOptionReportServerEntity->Categories | array | array |\r\n", "operationId": "GetSystemOptionReportServerEntityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable System Option Report Server Entity collection", "schema": { "$ref": "#/definitions/GetSystemOptionReportServerEntityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Report Server Entity" ], "summary": "Create a new System Option Report Server Entity resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | SystemOptionReportServerEntity->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| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | string | |\r\n| categories | SystemOptionReportServerEntity->Categories | 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| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionReportServerEntity", "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/CreateSystemOptionReportServerEntityResourceActionRequest" } }, { "$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/SYSTEM/Options/ReportServerEntities/Lookups/LookupSystemOptionReportServerEntityReportServerTag": { "get": { "tags": [ "System Option Report Server Entity" ], "summary": "Lookup the Report Server Tag for the System Option Report Server Entity.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ReportServerTag->Id | string | |\r\n| name | ReportServerTag->Name | string | |\r\n| documentCount | ReportServerTag->DocumentCount | integer | int64 |\r\n", "operationId": "LookupSystemOptionReportServerEntityReportServerTag", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Report Server Tag collection", "schema": { "$ref": "#/definitions/SystemOptionReportServerEntityCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReportServerEntities/Batch/{ids}": { "get": { "tags": [ "System Option Report Server Entity" ], "summary": "Get a collection of System Option Report Server Entity 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 | SystemOptionReportServerEntity->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionReportServerEntity->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionReportServerEntity->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionReportServerEntity->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionReportServerEntity->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionReportServerEntity->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionReportServerEntity->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionReportServerEntity->ModifiedOn | string | date-time |\r\n| version | SystemOptionReportServerEntity->Version | integer | int32 |\r\n| id | SystemOptionReportServerEntity->Id | integer | int64 |\r\n| categories | SystemOptionReportServerEntity->Categories | array | array |\r\n| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | string | |\r\n| entityType | SystemOptionReportServerEntity->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| systemOptionId | SystemOptionReportServerEntity->SystemOption_Id | integer | int64 |\r\n", "operationId": "BatchGetSystemOptionReportServerEntity", "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 System Option Report Server Entity 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 System Option Report Server Entity collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionReportServerEntityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReportServerEntities/Batch": { "post": { "tags": [ "System Option Report Server Entity" ], "summary": "Create a new collection of System Option Report Server Entity resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | SystemOptionReportServerEntity->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| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | string | |\r\n| categories | SystemOptionReportServerEntity->Categories | 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| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionReportServerEntity", "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/BatchCreateSystemOptionReportServerEntityRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Report Server Entity 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": [ "System Option Report Server Entity" ], "summary": "Update a collection of existing System Option Report Server Entity resources.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntity->Id | integer | int64 |\r\n| version | SystemOptionReportServerEntity->Version | integer | int32 |\r\n| categories | SystemOptionReportServerEntity->Categories | array | array |\r\n| defaultReportName | SystemOptionReportServerEntity->DefaultReportName | 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": "BatchUpdateSystemOptionReportServerEntity", "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/BatchUpdateSystemOptionReportServerEntityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity 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": [ "System Option Report Server Entity" ], "summary": "Delete a collection of existing System Option Report Server Entity resources.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntity->Id | integer | int64 |\r\n| version | SystemOptionReportServerEntity->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": "BatchDeleteSystemOptionReportServerEntity", "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/BatchDeleteSystemOptionReportServerEntityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity 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/SYSTEM/Options/ReportServerEntities/DefaultReports/{id}": { "get": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Get a System Option Report Server Entity Default Report 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 | SystemOptionReportServerEntityDefaultReport->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionReportServerEntityDefaultReport->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionReportServerEntityDefaultReport->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionReportServerEntityDefaultReport->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionReportServerEntityDefaultReport->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionReportServerEntityDefaultReport->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionReportServerEntityDefaultReport->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionReportServerEntityDefaultReport->ModifiedOn | string | date-time |\r\n| version | SystemOptionReportServerEntityDefaultReport->Version | integer | int32 |\r\n| id | SystemOptionReportServerEntityDefaultReport->Id | integer | int64 |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| notes | SystemOptionReportServerEntityDefaultReport->Notes | string | |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| systemOptionReportServerEntityId | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id | integer | int64 |\r\n| systemOptionReportServerEntityEntityType | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "GetSystemOptionReportServerEntityDefaultReport", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Report Server Entity Default Report Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Report Server Entity Default Report", "schema": { "$ref": "#/definitions/GetSystemOptionReportServerEntityDefaultReportResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Update an existing System Option Report Server Entity Default Report resource.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntityDefaultReport->Version | integer | int32 |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| notes | SystemOptionReportServerEntityDefaultReport->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| reportName | Nullable | False | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "UpdateSystemOptionReportServerEntityDefaultReport", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Report Server Entity Default Report Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity Default Report 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": [ "System Option Report Server Entity Default Report" ], "summary": "Delete an existing System Option Report Server Entity Default Report resource.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntityDefaultReport->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": "DeleteSystemOptionReportServerEntityDefaultReport", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Report Server Entity Default Report Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity Default Report 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/SYSTEM/Options/ReportServerEntities/{systemOptionReportServerEntityId}/DefaultReports": { "get": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Get a collection of System Option Report Server Entity Default Report resources for the System Option Report Server Entity.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SystemOptionReportServerEntityDefaultReport->Id | integer | int64 |\r\n| version | SystemOptionReportServerEntityDefaultReport->Version | integer | int32 |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSystemOptionReportServerEntityDefaultReportCollectionForSystemOptionReportServerEntity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "systemOptionReportServerEntityId", "in": "path", "required": true, "description": "System Option Report Server Entity 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 System Option Report Server Entity Default Report collection", "schema": { "$ref": "#/definitions/GetSystemOptionReportServerEntityDefaultReportCollectionForSystemOptionReportServerEntityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReportServerEntities/DefaultReports": { "get": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Get a collection of System Option Report Server Entity Default Report 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 | SystemOptionReportServerEntityDefaultReport->Version | integer | int32 |\r\n| id | SystemOptionReportServerEntityDefaultReport->Id | integer | int64 |\r\n| systemOptionReportServerEntityId | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id | integer | int64 |\r\n| systemOptionReportServerEntityEntityType | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_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| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| notes | SystemOptionReportServerEntityDefaultReport->Notes | string | |\r\n", "operationId": "GetSystemOptionReportServerEntityDefaultReportCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable System Option Report Server Entity Default Report collection", "schema": { "$ref": "#/definitions/GetSystemOptionReportServerEntityDefaultReportCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Create a new System Option Report Server Entity Default Report resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| systemOptionReportServerEntityId | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id | integer | int64 |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| notes | SystemOptionReportServerEntityDefaultReport->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| systemOptionReportServerEntityId | Required | True | |\r\n| systemOptionReportServerEntityId | Nullable | False | |\r\n| reportName | Required | True | |\r\n| reportName | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionReportServerEntityDefaultReport", "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/CreateSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, { "$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/SYSTEM/Options/ReportServerEntities/DefaultReports/Lookups/LookupSystemOptionReportServerEntityDefaultReportReportServerTag": { "get": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Lookup the Report Server Tag for the System Option Report Server Entity Default Report.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ReportServerTag->Id | string | |\r\n| name | ReportServerTag->Name | string | |\r\n| documentCount | ReportServerTag->DocumentCount | integer | int64 |\r\n", "operationId": "LookupSystemOptionReportServerEntityDefaultReportReportServerTag", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Report Server Tag collection", "schema": { "$ref": "#/definitions/SystemOptionReportServerEntityDefaultReportCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReportServerEntities/DefaultReports/Batch/{ids}": { "get": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Get a collection of System Option Report Server Entity Default Report 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 | SystemOptionReportServerEntityDefaultReport->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionReportServerEntityDefaultReport->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionReportServerEntityDefaultReport->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionReportServerEntityDefaultReport->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionReportServerEntityDefaultReport->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionReportServerEntityDefaultReport->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionReportServerEntityDefaultReport->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionReportServerEntityDefaultReport->ModifiedOn | string | date-time |\r\n| version | SystemOptionReportServerEntityDefaultReport->Version | integer | int32 |\r\n| id | SystemOptionReportServerEntityDefaultReport->Id | integer | int64 |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| notes | SystemOptionReportServerEntityDefaultReport->Notes | string | |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| systemOptionReportServerEntityId | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id | integer | int64 |\r\n| systemOptionReportServerEntityEntityType | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "BatchGetSystemOptionReportServerEntityDefaultReport", "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 System Option Report Server Entity Default Report 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 System Option Report Server Entity Default Report collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionReportServerEntityDefaultReportResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/ReportServerEntities/DefaultReports/Batch": { "post": { "tags": [ "System Option Report Server Entity Default Report" ], "summary": "Create a new collection of System Option Report Server Entity Default Report resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| systemOptionReportServerEntityId | SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id | integer | int64 |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| notes | SystemOptionReportServerEntityDefaultReport->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| systemOptionReportServerEntityId | Required | True | |\r\n| systemOptionReportServerEntityId | Nullable | False | |\r\n| reportName | Required | True | |\r\n| reportName | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionReportServerEntityDefaultReport", "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/BatchCreateSystemOptionReportServerEntityDefaultReportRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Report Server Entity Default Report 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": [ "System Option Report Server Entity Default Report" ], "summary": "Update a collection of existing System Option Report Server Entity Default Report resources.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntityDefaultReport->Id | integer | int64 |\r\n| version | SystemOptionReportServerEntityDefaultReport->Version | integer | int32 |\r\n| reportName | SystemOptionReportServerEntityDefaultReport->ReportName | string | |\r\n| expression | SystemOptionReportServerEntityDefaultReport->Expression | string | |\r\n| sequenceNumber | SystemOptionReportServerEntityDefaultReport->SequenceNumber | integer | int32 |\r\n| notes | SystemOptionReportServerEntityDefaultReport->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| reportName | Nullable | False | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSystemOptionReportServerEntityDefaultReport", "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/BatchUpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity Default Report 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": [ "System Option Report Server Entity Default Report" ], "summary": "Delete a collection of existing System Option Report Server Entity Default Report resources.", "description": "### Request Body\r\n#### 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 | SystemOptionReportServerEntityDefaultReport->Id | integer | int64 |\r\n| version | SystemOptionReportServerEntityDefaultReport->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": "BatchDeleteSystemOptionReportServerEntityDefaultReport", "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/BatchDeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Report Server Entity Default Report 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/SYSTEM/Options/Validations/Status/{id}": { "get": { "tags": [ "System Option Work Order Status" ], "summary": "Get a System Option 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| createdByUserId | SystemOptionWorkOrderStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionWorkOrderStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionWorkOrderStatus->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionWorkOrderStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionWorkOrderStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionWorkOrderStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionWorkOrderStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionWorkOrderStatus->ModifiedOn | string | date-time |\r\n| version | SystemOptionWorkOrderStatus->Version | integer | int32 |\r\n| id | SystemOptionWorkOrderStatus->Id | integer | int64 |\r\n| systemOptionId | SystemOptionWorkOrderStatus->SystemOption_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatus->ValidationType | string (Allowed values: [FailureAnalysis, MandatoryTasks, FollowUpWorkOrder, TypeOfWorkReadOnly, StartOnDate, CompleteByDate]) | enum |\r\n| workOrderStatusId | SystemOptionWorkOrderStatus->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | SystemOptionWorkOrderStatus->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | SystemOptionWorkOrderStatus->WorkOrderStatus_Description | string | |\r\n", "operationId": "GetSystemOptionWorkOrderStatus", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Work Order Status Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Work Order Status", "schema": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "System Option Work Order Status" ], "summary": "Delete an existing System Option 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 | SystemOptionWorkOrderStatus->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": "DeleteSystemOptionWorkOrderStatus", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Work Order Status Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option 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/SYSTEM/Options/Validations/Status": { "get": { "tags": [ "System Option Work Order Status" ], "summary": "Get a collection of System Option 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| createdByUserId | SystemOptionWorkOrderStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionWorkOrderStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionWorkOrderStatus->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionWorkOrderStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionWorkOrderStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionWorkOrderStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionWorkOrderStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionWorkOrderStatus->ModifiedOn | string | date-time |\r\n| version | SystemOptionWorkOrderStatus->Version | integer | int32 |\r\n| id | SystemOptionWorkOrderStatus->Id | integer | int64 |\r\n| systemOptionId | SystemOptionWorkOrderStatus->SystemOption_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatus->ValidationType | string (Allowed values: [FailureAnalysis, MandatoryTasks, FollowUpWorkOrder, TypeOfWorkReadOnly, StartOnDate, CompleteByDate]) | enum |\r\n| workOrderStatusId | SystemOptionWorkOrderStatus->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | SystemOptionWorkOrderStatus->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | SystemOptionWorkOrderStatus->WorkOrderStatus_Description | string | |\r\n", "operationId": "GetSystemOptionWorkOrderStatusCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Work Order Status collection", "schema": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Work Order Status" ], "summary": "Create a new System Option 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| workOrderStatusId | SystemOptionWorkOrderStatus->WorkOrderStatus_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatus->ValidationType | string (Allowed values: [FailureAnalysis, MandatoryTasks, FollowUpWorkOrder, TypeOfWorkReadOnly, StartOnDate, CompleteByDate]) | 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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | Nullable | False | |\r\n| validationType | Required | True | |\r\n| validationType | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionWorkOrderStatus", "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/CreateSystemOptionWorkOrderStatusResourceActionRequest" } }, { "$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/SYSTEM/Options/Validations/Status/Batch/{ids}": { "get": { "tags": [ "System Option Work Order Status" ], "summary": "Get a collection of System Option 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| createdByUserId | SystemOptionWorkOrderStatus->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionWorkOrderStatus->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionWorkOrderStatus->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionWorkOrderStatus->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionWorkOrderStatus->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionWorkOrderStatus->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionWorkOrderStatus->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionWorkOrderStatus->ModifiedOn | string | date-time |\r\n| version | SystemOptionWorkOrderStatus->Version | integer | int32 |\r\n| id | SystemOptionWorkOrderStatus->Id | integer | int64 |\r\n| systemOptionId | SystemOptionWorkOrderStatus->SystemOption_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatus->ValidationType | string (Allowed values: [FailureAnalysis, MandatoryTasks, FollowUpWorkOrder, TypeOfWorkReadOnly, StartOnDate, CompleteByDate]) | enum |\r\n| workOrderStatusId | SystemOptionWorkOrderStatus->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | SystemOptionWorkOrderStatus->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | SystemOptionWorkOrderStatus->WorkOrderStatus_Description | string | |\r\n", "operationId": "BatchGetSystemOptionWorkOrderStatus", "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 System Option 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 System Option Work Order Status collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionWorkOrderStatusResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Validations/Status/Batch": { "post": { "tags": [ "System Option Work Order Status" ], "summary": "Create a new collection of System Option 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| workOrderStatusId | SystemOptionWorkOrderStatus->WorkOrderStatus_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatus->ValidationType | string (Allowed values: [FailureAnalysis, MandatoryTasks, FollowUpWorkOrder, TypeOfWorkReadOnly, StartOnDate, CompleteByDate]) | 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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | Nullable | False | |\r\n| validationType | Required | True | |\r\n| validationType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionWorkOrderStatus", "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/BatchCreateSystemOptionWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option 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" } } }, "delete": { "tags": [ "System Option Work Order Status" ], "summary": "Delete a collection of existing System Option 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 | SystemOptionWorkOrderStatus->Id | integer | int64 |\r\n| version | SystemOptionWorkOrderStatus->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": "BatchDeleteSystemOptionWorkOrderStatus", "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/BatchDeleteSystemOptionWorkOrderStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option 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/SYSTEM/Options/Validations/StatusTypeOfWork/{id}": { "get": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Get a System Option Work Order Status Type Of Work 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 | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionWorkOrderStatusTypeOfWork->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionWorkOrderStatusTypeOfWork->ModifiedOn | string | date-time |\r\n| version | SystemOptionWorkOrderStatusTypeOfWork->Version | integer | int32 |\r\n| id | SystemOptionWorkOrderStatusTypeOfWork->Id | integer | int64 |\r\n| systemOptionId | SystemOptionWorkOrderStatusTypeOfWork->SystemOption_Id | integer | int64 |\r\n| typeOfWorkId | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| typeOfWorkWorkType | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| validationType | SystemOptionWorkOrderStatusTypeOfWork->ValidationType | string (Allowed values: [WorkOrderCodeReadOnly, LabourRequired, Downtime, PermitNumber, StandardTaskAdded, WorkPerformedRequired]) | enum |\r\n| workOrderStatusId | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Description | string | |\r\n", "operationId": "GetSystemOptionWorkOrderStatusTypeOfWork", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Work Order Status Type Of Work Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Work Order Status Type Of Work", "schema": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusTypeOfWorkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Delete an existing System Option Work Order Status Type Of Work resource.", "description": "### Request Body\r\n#### 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 | SystemOptionWorkOrderStatusTypeOfWork->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": "DeleteSystemOptionWorkOrderStatusTypeOfWork", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "System Option Work Order Status Type Of Work Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Work Order Status Type Of Work 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/SYSTEM/Options/Validations/StatusTypeOfWork": { "get": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Get a collection of System Option Work Order Status Type Of Work 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| createdByUserId | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionWorkOrderStatusTypeOfWork->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionWorkOrderStatusTypeOfWork->ModifiedOn | string | date-time |\r\n| version | SystemOptionWorkOrderStatusTypeOfWork->Version | integer | int32 |\r\n| id | SystemOptionWorkOrderStatusTypeOfWork->Id | integer | int64 |\r\n| systemOptionId | SystemOptionWorkOrderStatusTypeOfWork->SystemOption_Id | integer | int64 |\r\n| typeOfWorkId | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| typeOfWorkWorkType | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| validationType | SystemOptionWorkOrderStatusTypeOfWork->ValidationType | string (Allowed values: [WorkOrderCodeReadOnly, LabourRequired, Downtime, PermitNumber, StandardTaskAdded, WorkPerformedRequired]) | enum |\r\n| workOrderStatusId | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Description | string | |\r\n", "operationId": "GetSystemOptionWorkOrderStatusTypeOfWorkCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains System Option Work Order Status Type Of Work collection", "schema": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusTypeOfWorkCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Create a new System Option Work Order Status Type Of Work resource.", "description": "### Request Body\r\n#### 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 | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| typeOfWorkId | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatusTypeOfWork->ValidationType | string (Allowed values: [WorkOrderCodeReadOnly, LabourRequired, Downtime, PermitNumber, StandardTaskAdded, WorkPerformedRequired]) | 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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | Nullable | False | |\r\n| typeOfWorkId | Required | True | |\r\n| typeOfWorkId | Nullable | False | |\r\n| validationType | Required | True | |\r\n| validationType | Nullable | False | |\r\n\r\n", "operationId": "CreateSystemOptionWorkOrderStatusTypeOfWork", "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/CreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest" } }, { "$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/SYSTEM/Options/Validations/StatusTypeOfWork/Batch/{ids}": { "get": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Get a collection of System Option Work Order Status Type Of Work 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 | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_FullName | string | |\r\n| createdOn | SystemOptionWorkOrderStatusTypeOfWork->CreatedOn | string | date-time |\r\n| modifiedByUserId | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SystemOptionWorkOrderStatusTypeOfWork->ModifiedOn | string | date-time |\r\n| version | SystemOptionWorkOrderStatusTypeOfWork->Version | integer | int32 |\r\n| id | SystemOptionWorkOrderStatusTypeOfWork->Id | integer | int64 |\r\n| systemOptionId | SystemOptionWorkOrderStatusTypeOfWork->SystemOption_Id | integer | int64 |\r\n| typeOfWorkId | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Description | string | |\r\n| typeOfWorkWorkClass | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| typeOfWorkWorkType | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| validationType | SystemOptionWorkOrderStatusTypeOfWork->ValidationType | string (Allowed values: [WorkOrderCodeReadOnly, LabourRequired, Downtime, PermitNumber, StandardTaskAdded, WorkPerformedRequired]) | enum |\r\n| workOrderStatusId | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Description | string | |\r\n", "operationId": "BatchGetSystemOptionWorkOrderStatusTypeOfWork", "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 System Option Work Order Status Type Of Work 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 System Option Work Order Status Type Of Work collection", "schema": { "$ref": "#/definitions/BatchGetSystemOptionWorkOrderStatusTypeOfWorkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/Options/Validations/StatusTypeOfWork/Batch": { "post": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Create a new collection of System Option Work Order Status Type Of Work resources.", "description": "### Request Body\r\n#### 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 | SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| typeOfWorkId | SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id | integer | int64 |\r\n| validationType | SystemOptionWorkOrderStatusTypeOfWork->ValidationType | string (Allowed values: [WorkOrderCodeReadOnly, LabourRequired, Downtime, PermitNumber, StandardTaskAdded, WorkPerformedRequired]) | 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| workOrderStatusId | Required | True | |\r\n| workOrderStatusId | Nullable | False | |\r\n| typeOfWorkId | Required | True | |\r\n| typeOfWorkId | Nullable | False | |\r\n| validationType | Required | True | |\r\n| validationType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSystemOptionWorkOrderStatusTypeOfWork", "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/BatchCreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - System Option Work Order Status Type Of Work 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" } } }, "delete": { "tags": [ "System Option Work Order Status Type Of Work" ], "summary": "Delete a collection of existing System Option Work Order Status Type Of Work resources.", "description": "### Request Body\r\n#### 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 | SystemOptionWorkOrderStatusTypeOfWork->Id | integer | int64 |\r\n| version | SystemOptionWorkOrderStatusTypeOfWork->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": "BatchDeleteSystemOptionWorkOrderStatusTypeOfWork", "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/BatchDeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - System Option Work Order Status Type Of Work 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/SYSTEM/UserDefinedFields/{id}": { "get": { "tags": [ "User Defined Field" ], "summary": "Get a User Defined Field 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 | UserDefinedField->IsActive | boolean | |\r\n| createdByUserId | UserDefinedField->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDefinedField->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDefinedField->CreatedByUser_FullName | string | |\r\n| createdOn | UserDefinedField->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserDefinedField->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDefinedField->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDefinedField->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDefinedField->ModifiedOn | string | date-time |\r\n| version | UserDefinedField->Version | integer | int32 |\r\n| permissionTreeId | UserDefinedField->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDefinedField->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDefinedField->PermissionTree_Description | string | |\r\n| id | UserDefinedField->Id | integer | int64 |\r\n| dataType | UserDefinedField->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultPredefinedValueId | UserDefinedField->DefaultPredefinedValue_Id | integer | int64 |\r\n| defaultPredefinedValueDescription | UserDefinedField->DefaultPredefinedValue_Description | string | |\r\n| defaultPredefinedValueValue | UserDefinedField->DefaultPredefinedValue_Value | object | composite |\r\n| defaultValue | UserDefinedField->DefaultValue | object | composite |\r\n| description | UserDefinedField->Description | string | |\r\n| enableMatchUpdate | UserDefinedField->EnableMatchUpdate | boolean | |\r\n| entity | UserDefinedField->Entity | 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| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| isMemo | UserDefinedField->IsMemo | boolean | |\r\n| name | UserDefinedField->Name | string | |\r\n| notes | UserDefinedField->Notes | string | |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n", "operationId": "GetUserDefinedField", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Defined Field", "schema": { "$ref": "#/definitions/GetUserDefinedFieldResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Defined Field" ], "summary": "Update an existing User Defined Field resource.", "description": "### Request Body\r\n#### 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 | UserDefinedField->Version | integer | int32 |\r\n| name | UserDefinedField->Name | string | |\r\n| description | UserDefinedField->Description | string | |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| isMemo | UserDefinedField->IsMemo | boolean | |\r\n| enableMatchUpdate | UserDefinedField->EnableMatchUpdate | boolean | |\r\n| defaultValue | UserDefinedField->DefaultValue | object | composite |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n| defaultPredefinedValueId | UserDefinedField->DefaultPredefinedValue_Id | integer | int64 |\r\n| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| notes | UserDefinedField->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| name | Nullable | False | |\r\n| name | Pattern | ^[a-zA-Z]+[a-zA-Z0-9]*$ | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | 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| isMemo | Nullable | True | |\r\n| isMemo | Nullable | False | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | False | |\r\n| stringLength | Min Value | > 0| |\r\n| fieldType | Nullable | False | |\r\n\r\n", "operationId": "UpdateUserDefinedField", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserDefinedFieldResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field 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": [ "User Defined Field" ], "summary": "Delete an existing User Defined Field resource.", "description": "### Request Body\r\n#### 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 | UserDefinedField->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": "DeleteUserDefinedField", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserDefinedFieldResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field 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/SYSTEM/UserDefinedFields": { "get": { "tags": [ "User Defined Field" ], "summary": "Get a collection of User Defined Field 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 | UserDefinedField->Version | integer | int32 |\r\n| id | UserDefinedField->Id | integer | int64 |\r\n| entity | UserDefinedField->Entity | 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| name | UserDefinedField->Name | string | |\r\n| description | UserDefinedField->Description | string | |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| dataType | UserDefinedField->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n", "operationId": "GetUserDefinedFieldCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable User Defined Field collection", "schema": { "$ref": "#/definitions/GetUserDefinedFieldCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Defined Field" ], "summary": "Create a new User Defined Field resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entity | UserDefinedField->Entity | 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| name | UserDefinedField->Name | string | |\r\n| description | UserDefinedField->Description | string | |\r\n| permissionTreeId | UserDefinedField->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| dataType | UserDefinedField->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n| isMemo | UserDefinedField->IsMemo | boolean | |\r\n| enableMatchUpdate | UserDefinedField->EnableMatchUpdate | boolean | |\r\n| defaultValue | UserDefinedField->DefaultValue | object | composite |\r\n| defaultPredefinedValueId | UserDefinedField->DefaultPredefinedValue_Id | integer | int64 |\r\n| notes | UserDefinedField->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| entity | Required | True | |\r\n| entity | Nullable | False | |\r\n| name | Required | True | |\r\n| name | Nullable | False | |\r\n| name | Pattern | ^[a-zA-Z]+[a-zA-Z0-9]*$ | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| fieldType | Required | True | |\r\n| fieldType | Nullable | False | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | False | |\r\n| stringLength | Min Value | > 0| |\r\n| isMemo | Nullable | True | |\r\n| isMemo | Nullable | False | |\r\n\r\n", "operationId": "CreateUserDefinedField", "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/CreateUserDefinedFieldResourceActionRequest" } }, { "$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/SYSTEM/UserDefinedFields/Lookups/LookupUserDefinedFieldChangePermissionTree": { "get": { "tags": [ "User Defined Field" ], "summary": "Lookup the permission set for changing the User Defined Field.", "description": "### Response Body\r\n#### Payload\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": "LookupUserDefinedFieldChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/UserDefinedFieldChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/Lookups/LookupUserDefinedFieldInsertPermissionTree": { "get": { "tags": [ "User Defined Field" ], "summary": "Lookup the permission set for creating the User Defined Field.", "description": "### Response Body\r\n#### Payload\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": "LookupUserDefinedFieldInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/UserDefinedFieldInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/Lookups/LookupUserDefinedFieldUserDefinedFieldEntityType": { "get": { "tags": [ "User Defined Field" ], "summary": "User Defined Field", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | UserDefinedFieldEntityTypeSummary->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "LookupUserDefinedFieldUserDefinedFieldEntityType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable User Defined Field Entity collection", "schema": { "$ref": "#/definitions/UserDefinedFieldUserDefinedFieldEntityTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/Batch/{ids}": { "get": { "tags": [ "User Defined Field" ], "summary": "Get a collection of User Defined Field 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 | UserDefinedField->IsActive | boolean | |\r\n| createdByUserId | UserDefinedField->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDefinedField->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDefinedField->CreatedByUser_FullName | string | |\r\n| createdOn | UserDefinedField->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserDefinedField->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDefinedField->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDefinedField->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDefinedField->ModifiedOn | string | date-time |\r\n| version | UserDefinedField->Version | integer | int32 |\r\n| permissionTreeId | UserDefinedField->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDefinedField->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDefinedField->PermissionTree_Description | string | |\r\n| id | UserDefinedField->Id | integer | int64 |\r\n| dataType | UserDefinedField->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultPredefinedValueId | UserDefinedField->DefaultPredefinedValue_Id | integer | int64 |\r\n| defaultPredefinedValueDescription | UserDefinedField->DefaultPredefinedValue_Description | string | |\r\n| defaultPredefinedValueValue | UserDefinedField->DefaultPredefinedValue_Value | object | composite |\r\n| defaultValue | UserDefinedField->DefaultValue | object | composite |\r\n| description | UserDefinedField->Description | string | |\r\n| enableMatchUpdate | UserDefinedField->EnableMatchUpdate | boolean | |\r\n| entity | UserDefinedField->Entity | 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| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| isMemo | UserDefinedField->IsMemo | boolean | |\r\n| name | UserDefinedField->Name | string | |\r\n| notes | UserDefinedField->Notes | string | |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n", "operationId": "BatchGetUserDefinedField", "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 User Defined Field 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 User Defined Field collection", "schema": { "$ref": "#/definitions/BatchGetUserDefinedFieldResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/Batch": { "post": { "tags": [ "User Defined Field" ], "summary": "Create a new collection of User Defined Field resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entity | UserDefinedField->Entity | 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| name | UserDefinedField->Name | string | |\r\n| description | UserDefinedField->Description | string | |\r\n| permissionTreeId | UserDefinedField->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| dataType | UserDefinedField->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n| isMemo | UserDefinedField->IsMemo | boolean | |\r\n| enableMatchUpdate | UserDefinedField->EnableMatchUpdate | boolean | |\r\n| defaultValue | UserDefinedField->DefaultValue | object | composite |\r\n| defaultPredefinedValueId | UserDefinedField->DefaultPredefinedValue_Id | integer | int64 |\r\n| notes | UserDefinedField->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| entity | Required | True | |\r\n| entity | Nullable | False | |\r\n| name | Required | True | |\r\n| name | Nullable | False | |\r\n| name | Pattern | ^[a-zA-Z]+[a-zA-Z0-9]*$ | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| fieldType | Required | True | |\r\n| fieldType | Nullable | False | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | False | |\r\n| stringLength | Min Value | > 0| |\r\n| isMemo | Nullable | True | |\r\n| isMemo | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserDefinedField", "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/BatchCreateUserDefinedFieldRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Defined Field 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": [ "User Defined Field" ], "summary": "Update a collection of existing User Defined Field resources.", "description": "### Request Body\r\n#### 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 | UserDefinedField->Id | integer | int64 |\r\n| version | UserDefinedField->Version | integer | int32 |\r\n| description | UserDefinedField->Description | string | |\r\n| sequenceNumber | UserDefinedField->SequenceNumber | integer | int32 |\r\n| fieldType | UserDefinedField->FieldType | string (Allowed values: [Predefined, AnyValue, Both]) | enum |\r\n| stringLength | UserDefinedField->StringLength | integer | int32 |\r\n| isMemo | UserDefinedField->IsMemo | boolean | |\r\n| enableMatchUpdate | UserDefinedField->EnableMatchUpdate | boolean | |\r\n| name | UserDefinedField->Name | string | |\r\n| defaultValue | UserDefinedField->DefaultValue | object | composite |\r\n| defaultPredefinedValueId | UserDefinedField->DefaultPredefinedValue_Id | integer | int64 |\r\n| notes | UserDefinedField->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| fieldType | Nullable | False | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | True | |\r\n| stringLength | Nullable | False | |\r\n| stringLength | Min Value | > 0| |\r\n| isMemo | Nullable | True | |\r\n| isMemo | Nullable | False | |\r\n| name | Nullable | False | |\r\n| name | Pattern | ^[a-zA-Z]+[a-zA-Z0-9]*$ | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdateUserDefinedField", "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/BatchUpdateUserDefinedFieldResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field 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": [ "User Defined Field" ], "summary": "Delete a collection of existing User Defined Field resources.", "description": "### Request Body\r\n#### 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 | UserDefinedField->Id | integer | int64 |\r\n| version | UserDefinedField->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": "BatchDeleteUserDefinedField", "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/BatchDeleteUserDefinedFieldResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field 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/SYSTEM/UserDefinedFields/{id}/Active": { "patch": { "tags": [ "User Defined Field" ], "summary": "Change the IsActive status for an existing User Defined Field resource.", "description": "### Request Body\r\n#### 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 | UserDefinedField->Version | integer | int32 |\r\n| isActive | UserDefinedField->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": "ChangeUserDefinedFieldIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserDefinedFieldIsActiveResourceActionRequest" } }, { "$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/SYSTEM/UserDefinedFields/Batch/Active": { "patch": { "tags": [ "User Defined Field" ], "summary": "Change the IsActive status for a collection of existing User Defined Field resources.", "description": "### Request Body\r\n#### 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 | UserDefinedField->Id | integer | int64 |\r\n| version | UserDefinedField->Version | integer | int32 |\r\n| isActive | UserDefinedField->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": "BatchChangeUserDefinedFieldIsActive", "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/BatchChangeUserDefinedFieldIsActiveResourceActionRequest" } }, { "$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/SYSTEM/UserDefinedFields/PredefinedValues/{id}": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Get a User Defined Field Predefined Value 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 | UserDefinedFieldPredefinedValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDefinedFieldPredefinedValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDefinedFieldPredefinedValue->CreatedByUser_FullName | string | |\r\n| createdOn | UserDefinedFieldPredefinedValue->CreatedOn | string | date-time |\r\n| isActive | UserDefinedFieldPredefinedValue->IsActive | boolean | |\r\n| modifiedByUserId | UserDefinedFieldPredefinedValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDefinedFieldPredefinedValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDefinedFieldPredefinedValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDefinedFieldPredefinedValue->ModifiedOn | string | date-time |\r\n| permissionTreeId | UserDefinedFieldPredefinedValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDefinedFieldPredefinedValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDefinedFieldPredefinedValue->PermissionTree_Description | string | |\r\n| version | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| id | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| notes | UserDefinedFieldPredefinedValue->Notes | string | |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| userDefinedFieldId | UserDefinedFieldPredefinedValue->UserDefinedField_Id | integer | int64 |\r\n| userDefinedFieldEntity | UserDefinedFieldPredefinedValue->UserDefinedField_Entity | 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| userDefinedFieldDescription | UserDefinedFieldPredefinedValue->UserDefinedField_Description | string | |\r\n| userDefinedFieldName | UserDefinedFieldPredefinedValue->UserDefinedField_Name | string | |\r\n| userDefinedFieldDataType | UserDefinedFieldPredefinedValue->UserDefinedField_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| userDefinedFieldDefaultValue | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultValue | object | composite |\r\n| userDefinedFieldDefaultPredefinedValueId | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Id | integer | int64 |\r\n| userDefinedFieldDefaultPredefinedValueDescription | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Description | string | |\r\n| userDefinedFieldDefaultPredefinedValueValue | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Value | object | composite |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n", "operationId": "GetUserDefinedFieldPredefinedValue", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Predefined Value Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Defined Field Predefined Value", "schema": { "$ref": "#/definitions/GetUserDefinedFieldPredefinedValueResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Update an existing User Defined Field Predefined Value resource.", "description": "### Request Body\r\n#### 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 | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| notes | UserDefinedFieldPredefinedValue->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 | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateUserDefinedFieldPredefinedValue", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Predefined Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserDefinedFieldPredefinedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field Predefined Value 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": [ "User Defined Field Predefined Value" ], "summary": "Delete an existing User Defined Field Predefined Value resource.", "description": "### Request Body\r\n#### 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 | UserDefinedFieldPredefinedValue->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": "DeleteUserDefinedFieldPredefinedValue", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Predefined Value Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserDefinedFieldPredefinedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field Predefined Value 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/SYSTEM/UserDefinedFields/PredefinedValues": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Get a collection of User Defined Field Predefined Value 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 | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| id | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| userDefinedFieldId | UserDefinedFieldPredefinedValue->UserDefinedField_Id | integer | int64 |\r\n| userDefinedFieldEntity | UserDefinedFieldPredefinedValue->UserDefinedField_Entity | 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| userDefinedFieldName | UserDefinedFieldPredefinedValue->UserDefinedField_Name | string | |\r\n| userDefinedFieldDescription | UserDefinedFieldPredefinedValue->UserDefinedField_Description | string | |\r\n| userDefinedFieldDataType | UserDefinedFieldPredefinedValue->UserDefinedField_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n", "operationId": "GetUserDefinedFieldPredefinedValueCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable User Defined Field Predefined Value collection", "schema": { "$ref": "#/definitions/GetUserDefinedFieldPredefinedValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Create a new User Defined Field Predefined Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| userDefinedFieldId | UserDefinedFieldPredefinedValue->UserDefinedField_Id | integer | int64 |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| permissionTreeId | UserDefinedFieldPredefinedValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| isActive | UserDefinedFieldPredefinedValue->IsActive | boolean | |\r\n| notes | UserDefinedFieldPredefinedValue->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| userDefinedFieldId | Required | True | |\r\n| userDefinedFieldId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | 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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "CreateUserDefinedFieldPredefinedValue", "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/CreateUserDefinedFieldPredefinedValueResourceActionRequest" } }, { "$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/SYSTEM/UserDefinedFields/{userDefinedFieldId}/predefinedValues": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Get a collection of Predefined Value resources for the UserDefinedField.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| version | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| notes | UserDefinedFieldPredefinedValue->Notes | string | |\r\n| isActive | UserDefinedFieldPredefinedValue->IsActive | boolean | |\r\n", "operationId": "GetUserDefinedFieldPredefinedValueForUserDefinedFieldCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userDefinedFieldId", "in": "path", "required": true, "description": "User Defined Field 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 User Defined Field Predefined Value collection", "schema": { "$ref": "#/definitions/GetPredefinedValueForUserDefinedFieldCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/PredefinedValues/Lookups/LookupUserDefinedFieldPredefinedValue": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "User Defined Field Predefined Value", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n", "operationId": "LookupUserDefinedFieldPredefinedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable User Defined Field Predefined Value collection", "schema": { "$ref": "#/definitions/UserDefinedFieldPredefinedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/PredefinedValues/Lookups/LookupUserDefinedFieldPredefinedValueChangePermissionTree": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Lookup the permission set for changing the User Defined Field Predefined Value.", "description": "### Response Body\r\n#### Payload\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": "LookupUserDefinedFieldPredefinedValueChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/UserDefinedFieldPredefinedValueChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/PredefinedValues/Lookups/LookupUserDefinedFieldPredefinedValueInsertPermissionTree": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Lookup the permission set for creating the User Defined Field Predefined Value.", "description": "### Response Body\r\n#### Payload\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": "LookupUserDefinedFieldPredefinedValueInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/UserDefinedFieldPredefinedValueInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/PredefinedValues/Lookups/LookupUserDefinedFieldPredefinedValueUserDefinedField": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Lookup the User Defined Field for the User Defined Field Predefined Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UserDefinedField->Id | integer | int64 |\r\n| name | UserDefinedField->Name | string | |\r\n| description | UserDefinedField->Description | string | |\r\n| dataType | UserDefinedField->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| entity | UserDefinedField->Entity | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "LookupUserDefinedFieldPredefinedValueUserDefinedField", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable User Defined Field collection", "schema": { "$ref": "#/definitions/UserDefinedFieldPredefinedValueUserDefinedFieldLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/PredefinedValues/Batch/{ids}": { "get": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Get a collection of User Defined Field Predefined Value 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 | UserDefinedFieldPredefinedValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDefinedFieldPredefinedValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDefinedFieldPredefinedValue->CreatedByUser_FullName | string | |\r\n| createdOn | UserDefinedFieldPredefinedValue->CreatedOn | string | date-time |\r\n| isActive | UserDefinedFieldPredefinedValue->IsActive | boolean | |\r\n| modifiedByUserId | UserDefinedFieldPredefinedValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDefinedFieldPredefinedValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDefinedFieldPredefinedValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDefinedFieldPredefinedValue->ModifiedOn | string | date-time |\r\n| permissionTreeId | UserDefinedFieldPredefinedValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDefinedFieldPredefinedValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDefinedFieldPredefinedValue->PermissionTree_Description | string | |\r\n| version | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| id | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| notes | UserDefinedFieldPredefinedValue->Notes | string | |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| userDefinedFieldId | UserDefinedFieldPredefinedValue->UserDefinedField_Id | integer | int64 |\r\n| userDefinedFieldEntity | UserDefinedFieldPredefinedValue->UserDefinedField_Entity | 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| userDefinedFieldDescription | UserDefinedFieldPredefinedValue->UserDefinedField_Description | string | |\r\n| userDefinedFieldName | UserDefinedFieldPredefinedValue->UserDefinedField_Name | string | |\r\n| userDefinedFieldDataType | UserDefinedFieldPredefinedValue->UserDefinedField_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| userDefinedFieldDefaultValue | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultValue | object | composite |\r\n| userDefinedFieldDefaultPredefinedValueId | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Id | integer | int64 |\r\n| userDefinedFieldDefaultPredefinedValueDescription | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Description | string | |\r\n| userDefinedFieldDefaultPredefinedValueValue | UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Value | object | composite |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n", "operationId": "BatchGetUserDefinedFieldPredefinedValue", "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 User Defined Field Predefined Value 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 User Defined Field Predefined Value collection", "schema": { "$ref": "#/definitions/BatchGetUserDefinedFieldPredefinedValueResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/SYSTEM/UserDefinedFields/PredefinedValues/Batch": { "post": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Create a new collection of User Defined Field Predefined Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| userDefinedFieldId | UserDefinedFieldPredefinedValue->UserDefinedField_Id | integer | int64 |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| permissionTreeId | UserDefinedFieldPredefinedValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| isActive | UserDefinedFieldPredefinedValue->IsActive | boolean | |\r\n| notes | UserDefinedFieldPredefinedValue->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| userDefinedFieldId | Required | True | |\r\n| userDefinedFieldId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | 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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserDefinedFieldPredefinedValue", "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/BatchCreateUserDefinedFieldPredefinedValueRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Defined Field Predefined Value 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": [ "User Defined Field Predefined Value" ], "summary": "Update a collection of existing User Defined Field Predefined Value resources.", "description": "### Request Body\r\n#### 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 | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| version | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| value | UserDefinedFieldPredefinedValue->Value | object | composite |\r\n| description | UserDefinedFieldPredefinedValue->Description | string | |\r\n| sequenceNumber | UserDefinedFieldPredefinedValue->SequenceNumber | integer | int32 |\r\n| notes | UserDefinedFieldPredefinedValue->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 | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateUserDefinedFieldPredefinedValue", "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/BatchUpdateUserDefinedFieldPredefinedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field Predefined Value 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": [ "User Defined Field Predefined Value" ], "summary": "Delete a collection of existing User Defined Field Predefined Value resources.", "description": "### Request Body\r\n#### 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 | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| version | UserDefinedFieldPredefinedValue->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": "BatchDeleteUserDefinedFieldPredefinedValue", "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/BatchDeleteUserDefinedFieldPredefinedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Field Predefined Value 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/SYSTEM/UserDefinedFields/PredefinedValues/{id}/Active": { "patch": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Change the IsActive status for an existing User Defined Field Predefined Value resource.", "description": "### Request Body\r\n#### 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 | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| isActive | UserDefinedFieldPredefinedValue->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": "ChangeUserDefinedFieldPredefinedValueIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Field Predefined Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest" } }, { "$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/SYSTEM/UserDefinedFields/PredefinedValues/Batch/Active": { "patch": { "tags": [ "User Defined Field Predefined Value" ], "summary": "Change the IsActive status for a collection of existing User Defined Field Predefined Value resources.", "description": "### Request Body\r\n#### 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 | UserDefinedFieldPredefinedValue->Id | integer | int64 |\r\n| version | UserDefinedFieldPredefinedValue->Version | integer | int32 |\r\n| isActive | UserDefinedFieldPredefinedValue->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": "BatchChangeUserDefinedFieldPredefinedValueIsActive", "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/BatchChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "TraceContext": { "type": "object", "required": [ "SpanId", "TraceId" ], "properties": { "ParentSpanId": { "type": "string" }, "SpanId": { "type": "string" }, "TraceId": { "type": "string" } } }, "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" ] }, "GetBackgroundTaskResourceActionResponse": { "title": "GetBackgroundTaskResourceActionResponse", "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": "GetBackgroundTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->ModifiedOn" }, "alerted": { "title": "alerted", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTask->Alerted" }, "averageTimePerStep": { "title": "averageTimePerStep", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->AverageTimePerStep" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CompletedOn" }, "completedSteps": { "title": "completedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->CompletedSteps" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->ElapsedTime" }, "estimatedCompletion": { "title": "estimatedCompletion", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->EstimatedCompletion" }, "estimatedTimeRemaining": { "title": "estimatedTimeRemaining", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->EstimatedTimeRemaining" }, "failedSteps": { "title": "failedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->FailedSteps" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->Name" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTask->Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "priority": { "title": "priority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->Priority" }, "remainingSteps": { "title": "remainingSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->RemainingSteps" }, "skippedSteps": { "title": "skippedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->SkippedSteps" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->StartedOn" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTask->Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "totalSteps": { "title": "totalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->TotalSteps" }, "trace": { "title": "trace", "x-nullable": true, "$ref": "#/definitions/TraceContext", "x-propertyPath": "BackgroundTask->Trace" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->Type" } } }, "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" } } }, "GetBackgroundTaskErrorListResourceActionResponse": { "title": "GetBackgroundTaskErrorListResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Code" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskError->CompletedOn" }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->ObjectType", "x-formatSpecifier": "EntityType" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Message" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Type" }, "objectId": { "title": "objectId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->ObjectId" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->SequenceNumber" }, "severity": { "title": "severity", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->Severity" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskError->StartedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskError->CreatedByUserId" } } }, "GetBackgroundTaskErrorListResourceAction": { "title": "GetBackgroundTaskErrorListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Background Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Background Task entities", "items": { "$ref": "#/definitions/GetBackgroundTaskErrorListResourceActionResponse" } }, "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" } } }, "GetBackgroundTaskCollectionResourceActionResponse": { "title": "GetBackgroundTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBackgroundTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->Name" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTask->Type" }, "priority": { "title": "priority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->Priority" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTask->Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTask->Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "alerted": { "title": "alerted", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTask->Alerted" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CompletedOn" }, "totalSteps": { "title": "totalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->TotalSteps" }, "failedSteps": { "title": "failedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->FailedSteps" }, "completedSteps": { "title": "completedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->CompletedSteps" }, "remainingSteps": { "title": "remainingSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->RemainingSteps" }, "skippedSteps": { "title": "skippedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTask->SkippedSteps" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->ElapsedTime" }, "averageTimePerStep": { "title": "averageTimePerStep", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->AverageTimePerStep" }, "estimatedTimeRemaining": { "title": "estimatedTimeRemaining", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->EstimatedTimeRemaining" }, "estimatedCompletion": { "title": "estimatedCompletion", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->EstimatedCompletion" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse": { "title": "GetBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Name" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Name" }, "backgroundTaskType": { "title": "backgroundTaskType", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Type" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskOrigin": { "title": "backgroundTaskOrigin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CompletedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->SequenceNumber" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "BackgroundTaskStep->Response" }, "isValid": { "title": "isValid", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->IsValid" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DeleteBackgroundTaskResourceActionRequest": { "title": "DeleteBackgroundTaskResourceActionRequest", "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 } } }, "BatchGetBackgroundTaskResourceAction": { "title": "BatchGetBackgroundTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Background Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Background Task entities", "items": { "$ref": "#/definitions/GetBackgroundTaskResourceActionResponse" } }, "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" } } }, "BatchDeleteBackgroundTaskResourceActionRequest": { "title": "BatchDeleteBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteBackgroundTaskResourceActionRequest" } }, "BulkCreateBackgroundTaskLoadResourceActionRequest": { "title": "BulkCreateBackgroundTaskLoadResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BulkCreateBackgroundTaskLoadResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "injectDomainEventFaults": { "title": "injectDomainEventFaults", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->InjectDomainEventFaults" }, "injectFaults": { "title": "injectFaults", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->InjectFaults" }, "loadInterval": { "title": "loadInterval", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BulkCreateBackgroundTaskLoad->LoadInterval" }, "maximumDelay": { "title": "maximumDelay", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BulkCreateBackgroundTaskLoad->MaximumDelay" }, "maximumPriority": { "title": "maximumPriority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->MaximumPriority" }, "maximumStepCount": { "title": "maximumStepCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->MaximumStepCount" }, "minimumDelay": { "title": "minimumDelay", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BulkCreateBackgroundTaskLoad->MinimumDelay" }, "minimumPriority": { "title": "minimumPriority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->MinimumPriority" }, "minimumStepCount": { "title": "minimumStepCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->MinimumStepCount" }, "randomUsers": { "title": "randomUsers", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->RandomUsers" }, "simulateChangeDataSubscriptions": { "title": "simulateChangeDataSubscriptions", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->SimulateChangeDataSubscriptions" }, "simulateChangeDataTriggers": { "title": "simulateChangeDataTriggers", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->SimulateChangeDataTriggers" }, "simulateChangeLog": { "title": "simulateChangeLog", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->SimulateChangeLog" }, "simulateDomainEvents": { "title": "simulateDomainEvents", "type": "boolean", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->SimulateDomainEvents" }, "taskCount": { "title": "taskCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->TaskCount" }, "userCount": { "title": "userCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BulkCreateBackgroundTaskLoad->UserCount" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "CreateBackgroundTaskLoadResourceActionRequest": { "title": "CreateBackgroundTaskLoadResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateBackgroundTaskLoadResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "injectDomainEventFaults": { "title": "injectDomainEventFaults", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->InjectDomainEventFaults" }, "injectFaults": { "title": "injectFaults", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->InjectFaults" }, "maximumDelay": { "title": "maximumDelay", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "CreateBackgroundTaskLoad->MaximumDelay" }, "minimumDelay": { "title": "minimumDelay", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "CreateBackgroundTaskLoad->MinimumDelay" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "priority": { "title": "priority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->Priority" }, "simulateChangeDataSubscriptions": { "title": "simulateChangeDataSubscriptions", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->SimulateChangeDataSubscriptions" }, "simulateChangeDataTriggers": { "title": "simulateChangeDataTriggers", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->SimulateChangeDataTriggers" }, "simulateChangeLog": { "title": "simulateChangeLog", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->SimulateChangeLog" }, "simulateDomainEvents": { "title": "simulateDomainEvents", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->SimulateDomainEvents" }, "stepCount": { "title": "stepCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->StepCount" }, "taskName": { "title": "taskName", "type": "string", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->TaskName" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateBackgroundTaskLoad->UserId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GetBackgroundTaskStepResourceActionResponse": { "title": "GetBackgroundTaskStepResourceActionResponse", "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": "GetBackgroundTaskStepResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->ModifiedOn" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Id" }, "backgroundTaskCompletedSteps": { "title": "backgroundTaskCompletedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_CompletedSteps" }, "backgroundTaskCompletedOn": { "title": "backgroundTaskCompletedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->BackgroundTask_CompletedOn" }, "backgroundTaskFailedSteps": { "title": "backgroundTaskFailedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_FailedSteps" }, "backgroundTaskCreatedByUserId": { "title": "backgroundTaskCreatedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_CreatedByUser_Id" }, "backgroundTaskCreatedByUserCode": { "title": "backgroundTaskCreatedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_CreatedByUser_Code" }, "backgroundTaskCreatedByUserFullName": { "title": "backgroundTaskCreatedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_CreatedByUser_FullName" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Name" }, "backgroundTaskOrigin": { "title": "backgroundTaskOrigin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "backgroundTaskPriority": { "title": "backgroundTaskPriority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Priority" }, "backgroundTaskSkippedSteps": { "title": "backgroundTaskSkippedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_SkippedSteps" }, "backgroundTaskStartedOn": { "title": "backgroundTaskStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->BackgroundTask_StartedOn" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskTotalSteps": { "title": "backgroundTaskTotalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_TotalSteps" }, "backgroundTaskTrace": { "title": "backgroundTaskTrace", "x-nullable": true, "$ref": "#/definitions/TraceContext", "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Trace" }, "backgroundTaskType": { "title": "backgroundTaskType", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Type" }, "backgroundTaskCreatedOn": { "title": "backgroundTaskCreatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->BackgroundTaskCreatedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CompletedOn" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "isValid": { "title": "isValid", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->IsValid" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Name" }, "priority": { "title": "priority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Priority" }, "requestJson": { "title": "requestJson", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->RequestJson" }, "requestTypeFullName": { "title": "requestTypeFullName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->RequestTypeFullName" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "BackgroundTaskStep->Response" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->SequenceNumber" }, "skipped": { "title": "skipped", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Skipped" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->StartedOn" }, "trace": { "title": "trace", "x-nullable": true, "$ref": "#/definitions/TraceContext", "x-propertyPath": "BackgroundTaskStep->Trace" } } }, "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" } } }, "GetBackgroundTaskStepCollectionResourceActionResponse": { "title": "GetBackgroundTaskStepCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetBackgroundTaskStepCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetBackgroundTaskStepCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->Name" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Name" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskOrigin": { "title": "backgroundTaskOrigin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CompletedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->SequenceNumber" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "BackgroundTaskStep->Response" }, "isValid": { "title": "isValid", "type": "boolean", "x-nullable": true, "x-propertyPath": "BackgroundTaskStep->IsValid" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BatchGetBackgroundTaskStepResourceAction": { "title": "BatchGetBackgroundTaskStepResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Background Task Step entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Background Task Step entities", "items": { "$ref": "#/definitions/GetBackgroundTaskStepResourceActionResponse" } }, "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" } } }, "GetRecordChangeCollectionResourceActionResponse": { "title": "GetRecordChangeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRecordChangeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRecordChangeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "persistedOn": { "title": "persistedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RecordChange->PersistedOn" }, "changedOn": { "title": "changedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RecordChange->ChangedOn" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChange->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChange->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChange->User_FullName" }, "entityId": { "title": "entityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChange->EntityId" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RecordChange->EntityType", "x-formatSpecifier": "EntityType" }, "entityChangeType": { "title": "entityChangeType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RecordChange->EntityChangeType", "x-formatSpecifier": "ChangeType" }, "entityVersion": { "title": "entityVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RecordChange->EntityVersion" }, "requestTypes": { "title": "requestTypes", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "RecordChange->RequestTypes", "x-formatSpecifier": "Int64" }, "traceId": { "title": "traceId", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChange->TraceId" }, "requestStepId": { "title": "requestStepId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "RecordChange->RequestStepId" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRecordChangeValueCollectionResourceActionResponse": { "title": "GetRecordChangeValueCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRecordChangeValueCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRecordChangeValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "propertyId": { "title": "propertyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValue->Property_Id" }, "propertyPropertyPath": { "title": "propertyPropertyPath", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->Property_PropertyPath" }, "oldValue": { "title": "oldValue", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->OldValue" }, "newValue": { "title": "newValue", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->NewValue" }, "recordChangeId": { "title": "recordChangeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValue->RecordChange_Id" }, "recordChangeEntityId": { "title": "recordChangeEntityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValue->RecordChange_EntityId" }, "recordChangeUserId": { "title": "recordChangeUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValue->RecordChange_User_Id" }, "recordChangeUserCode": { "title": "recordChangeUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->RecordChange_User_Code" }, "recordChangeUserFullName": { "title": "recordChangeUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->RecordChange_User_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" } } } }, "GetRecordChangeValueFromRecordChangeCollectionResourceActionResponse": { "title": "GetRecordChangeValueFromRecordChangeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRecordChangeValueFromRecordChangeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRecordChangeValueFromRecordChangeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "propertyId": { "title": "propertyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValue->Property_Id" }, "propertyPropertyPath": { "title": "propertyPropertyPath", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->Property_PropertyPath" }, "oldValue": { "title": "oldValue", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->OldValue" }, "newValue": { "title": "newValue", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValue->NewValue" }, "recordChangeId": { "title": "recordChangeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValue->RecordChange_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" } } } }, "RecordChangeValuePathIds": { "title": "RecordChangeValuePathIds", "type": "object", "properties": { "properties": { "title": "RecordChangeValuePathIdsProperties", "type": "object", "x-nullable": false, "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "RecordChangeValuePathIds->Ids", "x-formatSpecifier": "Int64" }, "propertyPath": { "title": "propertyPath", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValuePathIds->PropertyPath" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GetRecordChangeValueReferenceCollectionResourceActionRequest": { "title": "GetRecordChangeValueReferenceCollectionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/RecordChangeValuePathIds" } }, "GetRecordChangeValueReferenceCollectionResourceActionResponse": { "title": "GetRecordChangeValueReferenceCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RecordChangeValueReferenceValue->Id" }, "propertyPath": { "title": "propertyPath", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValueReferenceValue->PropertyPath" }, "valuePropertyPath": { "title": "valuePropertyPath", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValueReferenceValue->ValuePropertyPath" }, "value": { "title": "value", "type": "string", "x-nullable": true, "x-propertyPath": "RecordChangeValueReferenceValue->Value" } } }, "GetRecordChangeValueReferenceCollectionResourceAction": { "title": "GetRecordChangeValueReferenceCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Log entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Log entities", "items": { "$ref": "#/definitions/GetRecordChangeValueReferenceCollectionResourceActionResponse" } }, "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" } } }, "GetDelayedSideEffectSummaryListResourceActionResponse": { "title": "GetDelayedSideEffectSummaryListResourceActionResponse", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DelayedSideEffectSummary->EntityType", "x-formatSpecifier": "EntityType" }, "queued": { "title": "queued", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DelayedSideEffectSummary->Queued" }, "reason": { "title": "reason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DelayedSideEffectSummary->Reason", "x-formatSpecifier": "DelayedSideEffectReasonType" } } }, "GetDelayedSideEffectSummaryListResourceAction": { "title": "GetDelayedSideEffectSummaryListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Delayed Side Effects entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Delayed Side Effects entities", "items": { "$ref": "#/definitions/GetDelayedSideEffectSummaryListResourceActionResponse" } }, "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" } } }, "DelayedSideEffectSummary": { "title": "DelayedSideEffectSummary", "type": "object", "properties": { "properties": { "title": "DelayedSideEffectSummaryProperties", "type": "object", "x-nullable": false, "required": [ "reason" ], "properties": { "reason": { "title": "reason", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "DelayedSideEffectSummary->Reason", "x-formatSpecifier": "DelayedSideEffectReasonType" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DelayedSideEffectSummary->EntityType", "x-formatSpecifier": "EntityType" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ExecuteDelayedSideEffectJobsResourceActionRequest": { "title": "ExecuteDelayedSideEffectJobsResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DelayedSideEffectSummary" } }, "CalculateDefaultReportListResourceActionRequest": { "title": "CalculateDefaultReportListResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CalculateDefaultReportListResourceActionRequestProperties", "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 } } }, "CalculateEntityDefaultReportsResourceActionResponse": { "title": "CalculateEntityDefaultReportsResourceActionResponse", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "DefaultReport->EntityType", "x-formatSpecifier": "EntityType" }, "reportId": { "title": "reportId", "type": "string", "x-nullable": true, "x-propertyPath": "DefaultReport->ReportId" }, "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "DefaultReport->EntityIds", "x-formatSpecifier": "Int64" } } }, "CalculateDefaultReportListResourceAction": { "title": "CalculateDefaultReportListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Entities entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Entities entities", "items": { "$ref": "#/definitions/CalculateEntityDefaultReportsResourceActionResponse" } }, "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" } } }, "EntityExistCheckType": { "type": "string", "description": "", "x-nullable": true, "example": "Custom", "x-enumNames": [ "Code", "Custom" ], "enum": [ "Code", "Custom" ] }, "EntityExistCheckSchema": { "title": "EntityExistCheckSchema", "type": "object", "required": [ "entityType", "userObjectId", "properties" ], "properties": { "checkType": { "$ref": "#/definitions/EntityExistCheckType" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "example": "RegularAsset", "x-formatSpecifier": "EntityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Unique caller identifier. Used to associate and echo results back to the caller", "x-nullable": false, "example": "MyUniqueAsset" }, "properties": { "title": "EntityExistCheckSchemaProperties", "type": "object", "description": "A map of key-value pairs containing the property paths and values of the properties to use for the exist check", "x-nullable": false, "example": { "RegularAsset->AssetType_Code": "*1089", "RegularAsset->CostCentre_Code": "095" } } } }, "EntityExistCheckCollectionSchema": { "title": "EntityExistCheckCollectionSchema", "type": "array", "description": "Collection of checks to execute", "items": { "$ref": "#/definitions/EntityExistCheckSchema" } }, "EntityExistsCheckResultCollectionSchema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of resource items", "items": { "$ref": "#/definitions/EntityExistsCheckResultSchema" } } } }, "EntityExistsCheckResultSchema": { "type": "object", "required": [ "Exists" ], "properties": { "UserObjectId": { "type": "string" }, "Exists": { "type": "boolean" }, "Id": { "type": "integer", "format": "int64" }, "Version": { "type": "integer", "format": "int32" }, "Entity": { "$ref": "#/definitions/EntitySchema" } } }, "EntitySchema": { "type": "object", "required": [ "class", "properties", "links" ], "properties": { "class": { "type": "string", "description": "Type of resource" }, "id": { "type": "integer", "description": "Id of Resource", "format": "int64" }, "version": { "type": "integer", "description": "Version of Resource", "format": "int32" }, "properties": { "type": "object", "description": "List of properties as a map `{ \"name\" : value, ...}`", "additionalProperties": {} }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "permissionViolations": { "type": "array", "description": "List of permission violations for resource data", "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "permissionViolationsLookup": { "description": "Lookup to find more information about the permission violations", "$ref": "#/definitions/PermissionViolationLookupSchema" }, "translations": { "type": "array", "description": "Translations for resource data", "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "description": "Self link to re-execute", "$ref": "#/definitions/Link" } } }, "PermissionViolationLookupSchema": { "type": "object", "properties": { "permissions": { "type": "array", "description": "Lookup table to find more information about the permissions for the violations", "items": { "$ref": "#/definitions/PermissionViolationPermissionLookupSchema" } }, "permissionTrees": { "type": "array", "description": "Lookup table to find more information about the permission trees for the violations", "items": { "$ref": "#/definitions/PermissionViolationTreeCodeLookupSchema" } } } }, "PermissionViolationPermissionLookupSchema": { "type": "object", "required": [ "permissionId", "permissionCategory", "permissionSubcategory", "permissionEntityName", "permissionName" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionCategory": { "type": "string" }, "permissionSubcategory": { "type": "string" }, "permissionEntityName": { "type": "string" }, "permissionName": { "type": "string" } } }, "PermissionViolationTreeCodeLookupSchema": { "type": "object", "required": [ "permissionTreeId", "permissionTreeCode" ], "properties": { "permissionTreeId": { "type": "integer", "format": "int64" }, "permissionTreeCode": { "type": "string" } } }, "GetTenantHealthIndicatorListResourceActionResponse": { "title": "GetTenantHealthIndicatorListResourceActionResponse", "type": "object", "properties": { "identityToken": { "title": "identityToken", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicator->IdentityToken" }, "errors": { "title": "errors", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicator->Errors" }, "healthStatus": { "title": "healthStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TenantHealthIndicator->HealthStatus", "x-formatSpecifier": "SystemHealthStatus" }, "area": { "title": "area", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicator->Area" }, "lastMeasuredOn": { "title": "lastMeasuredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TenantHealthIndicator->LastMeasuredOn" } } }, "GetTenantHealthIndicatorListResourceAction": { "title": "GetTenantHealthIndicatorListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Health entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Health entities", "items": { "$ref": "#/definitions/GetTenantHealthIndicatorListResourceActionResponse" } }, "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" } } }, "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" } } }, "GetTenantHealthIndicatorValueListForAreaResourceActionResponse": { "title": "GetTenantHealthIndicatorValueListForAreaResourceActionResponse", "type": "object", "properties": { "area": { "title": "area", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicatorValue->Area" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicatorValue->Name" }, "severity": { "title": "severity", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TenantHealthIndicatorValue->Severity", "x-formatSpecifier": "SeverityType" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "TenantHealthIndicatorValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "GetTenantHealthIndicatorValueListForAreaResourceAction": { "title": "GetTenantHealthIndicatorValueListForAreaResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Health entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Health entities", "items": { "$ref": "#/definitions/GetTenantHealthIndicatorValueListForAreaResourceActionResponse" } }, "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" } } }, "GetTenantHealthIndicatorValueListResourceActionResponse": { "title": "GetTenantHealthIndicatorValueListResourceActionResponse", "type": "object", "properties": { "area": { "title": "area", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicatorValue->Area" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "TenantHealthIndicatorValue->Name" }, "severity": { "title": "severity", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TenantHealthIndicatorValue->Severity", "x-formatSpecifier": "SeverityType" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "TenantHealthIndicatorValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "GetTenantHealthIndicatorValueListResourceAction": { "title": "GetTenantHealthIndicatorValueListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Health entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Health entities", "items": { "$ref": "#/definitions/GetTenantHealthIndicatorValueListResourceActionResponse" } }, "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" } } }, "UploadImportFileResourceActionRequest": { "title": "UploadImportFileResourceActionRequest", "type": "object", "properties": { "importSchemaId": { "title": "importSchemaId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->ImportSchema_Id" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->Description" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportFile->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "orderedImport": { "title": "orderedImport", "type": "boolean", "x-nullable": false, "x-propertyPath": "ImportFile->OrderedImport" }, "file": { "type": "string", "format": "binary" } } }, "CsvContent": { "type": "object", "properties": { "Content": { "type": "string" } } }, "ImportAction": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Create", "Update", "Merge", "Delete" ], "enum": [ "Create", "Update", "Merge", "Delete" ] }, "ImportModel": { "title": "ImportModel", "type": "object", "required": [ "action", "entityType", "userObjectId" ], "properties": { "action": { "$ref": "#/definitions/ImportAction" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "EntityType" }, "id": { "title": "id", "type": "object", "description": "Id for the entity being imported or the converter information to use to uniquely identify the entity in On Key", "x-nullable": true, "required": [ "converter" ], "properties": { "converter": { "title": "converter", "type": "string", "description": "Name of the converter", "x-nullable": false }, "type": { "$ref": "#/definitions/EntityExistCheckType" }, "code": { "title": "code", "type": "string", "description": "The code to use if a Code converter is being used. Not required for Custom converters", "x-nullable": true }, "properties": { "title": "converterProperties", "type": "object", "description": "The properties to use if a Custom converter is being used. Not required for Code converters", "x-nullable": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Unique caller identifier for the import model. Used to associate and echo import results back to the caller", "x-nullable": false }, "groupOrder": { "title": "groupOrder", "type": "integer", "description": "Optional group order identifier to group records together and execute them in ascending group sequence", "format": "int32", "x-nullable": true }, "properties": { "title": "ImportModelProperties", "type": "object" } } }, "EntityImportCollectionSchema": { "title": "EntityImportCollectionSchema", "type": "array", "description": "Collection of models to import", "items": { "$ref": "#/definitions/ImportModel" } }, "GetImportFileResourceActionResponse": { "title": "GetImportFileResourceActionResponse", "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": "GetImportFileResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportFile->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportFile->ModifiedOn" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_Name" }, "backgroundTaskStartedOn": { "title": "backgroundTaskStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportFile->BackgroundTask_StartedOn" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskFailedSteps": { "title": "backgroundTaskFailedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_FailedSteps" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->Description" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportFile->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->FileName" }, "importSchemaId": { "title": "importSchemaId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->ImportSchema_Id" }, "importSchemaName": { "title": "importSchemaName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->ImportSchema_Name" }, "importSchemaDescription": { "title": "importSchemaDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->ImportSchema_Description" }, "orderedImport": { "title": "orderedImport", "type": "boolean", "x-nullable": false, "x-propertyPath": "ImportFile->OrderedImport" } } }, "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" } } }, "GetImportFileResultListResourceActionResponse": { "title": "GetImportFileResultListResourceActionResponse", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFileResult->Code" }, "entityId": { "title": "entityId", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFileResult->EntityId" }, "importRecordNumber": { "title": "importRecordNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ImportFileResult->ImportRecordNumber" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "ImportFileResult->Message" }, "properties": { "title": "properties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "ImportFileResult->Properties", "x-formatSpecifier": "String" }, "severity": { "title": "severity", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ImportFileResult->Severity", "x-formatSpecifier": "SeverityType" } } }, "GetImportFileResultListResourceAction": { "title": "GetImportFileResultListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Import File entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Import File entities", "items": { "$ref": "#/definitions/GetImportFileResultListResourceActionResponse" } }, "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" } } }, "GetImportFileCollectionResourceActionResponse": { "title": "GetImportFileCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetImportFileCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetImportFileCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "importSchemaId": { "title": "importSchemaId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->ImportSchema_Id" }, "importSchemaName": { "title": "importSchemaName", "type": "string", "x-nullable": false, "x-propertyPath": "ImportFile->ImportSchema_Name" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportFile->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "orderedImport": { "title": "orderedImport", "type": "boolean", "x-nullable": false, "x-propertyPath": "ImportFile->OrderedImport" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->FileName" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->Description" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_Name" }, "backgroundTaskStartedOn": { "title": "backgroundTaskStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportFile->BackgroundTask_StartedOn" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskFailedSteps": { "title": "backgroundTaskFailedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ImportFile->BackgroundTask_FailedSteps" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportFile->CreatedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportFile->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "ImportFile->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "ImportFile->CreatedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportFile->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" } } } }, "ImportFileImportSchemaLookupResourceActionResponse": { "title": "ImportFileImportSchemaLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ImportFileImportSchemaLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ImportFileImportSchemaLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Description" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportSchema->RestrictionLevel", "x-formatSpecifier": "ImportSchemaRestrictionLevel" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "DeleteImportFileResourceActionRequest": { "title": "DeleteImportFileResourceActionRequest", "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 } } }, "BatchGetImportFileResourceAction": { "title": "BatchGetImportFileResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Import File entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Import File entities", "items": { "$ref": "#/definitions/GetImportFileResourceActionResponse" } }, "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" } } }, "BatchDeleteImportFileResourceActionRequest": { "title": "BatchDeleteImportFileResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteImportFileResourceActionRequest" } }, "GetImportSchemaResourceActionResponse": { "title": "GetImportSchemaResourceActionResponse", "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": "GetImportSchemaResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportSchema->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportSchema->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportSchema->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportSchema->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Description" }, "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "ImportSchema->IsSystem" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Name" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Notes" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportSchema->RestrictionLevel", "x-formatSpecifier": "ImportSchemaRestrictionLevel" }, "schema": { "title": "schema", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Schema" } } }, "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" } } }, "GetImportSchemaCollectionResourceActionResponse": { "title": "GetImportSchemaCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetImportSchemaCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetImportSchemaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "ImportSchema->IsSystem" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Notes" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportSchema->RestrictionLevel", "x-formatSpecifier": "ImportSchemaRestrictionLevel" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportSchema->CreatedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ImportSchema->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->CreatedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ImportSchema->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" } } } }, "ImportSchemaCopySchemaLookupResourceActionResponse": { "title": "ImportSchemaCopySchemaLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ImportSchemaCopySchemaLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ImportSchemaCopySchemaLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Description" }, "schema": { "title": "schema", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Schema" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportSchema->RestrictionLevel", "x-formatSpecifier": "ImportSchemaRestrictionLevel" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateImportSchemaResourceActionRequest": { "title": "CreateImportSchemaResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateImportSchemaResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "name", "schema" ], "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Notes" }, "schema": { "title": "schema", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Schema" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportSchema->RestrictionLevel", "x-formatSpecifier": "ImportSchemaRestrictionLevel" } } }, "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" } } }, "UpdateImportSchemaResourceActionRequest": { "title": "UpdateImportSchemaResourceActionRequest", "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": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Name" }, { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ImportSchema->Notes" }, { "title": "schema", "type": "string", "x-nullable": false, "x-propertyPath": "ImportSchema->Schema" }, { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ImportSchema->RestrictionLevel", "x-formatSpecifier": "ImportSchemaRestrictionLevel" } ] } } }, "DeleteImportSchemaResourceActionRequest": { "title": "DeleteImportSchemaResourceActionRequest", "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 } } }, "BatchGetImportSchemaResourceAction": { "title": "BatchGetImportSchemaResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Import Schema entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Import Schema entities", "items": { "$ref": "#/definitions/GetImportSchemaResourceActionResponse" } }, "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" } } }, "BatchCreateImportSchemaResourceActionRequest": { "title": "BatchCreateImportSchemaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateImportSchemaResourceActionRequest" } }, "BatchUpdateImportSchemaResourceActionRequest": { "title": "BatchUpdateImportSchemaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateImportSchemaResourceActionRequest" } }, "BatchDeleteImportSchemaResourceActionRequest": { "title": "BatchDeleteImportSchemaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteImportSchemaResourceActionRequest" } }, "GenerateExportProfileResourceActionResponse": { "title": "GenerateExportProfileResourceActionResponse", "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": "GenerateExportProfileResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateExportProfileResult->TemplateCustomisationId" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "GenerateExportProfileResult->ResourceActionCustomisationId" }, "template": { "title": "template", "type": "string", "x-nullable": true, "x-propertyPath": "GenerateExportProfileResult->Template" }, "resource": { "title": "resource", "type": "string", "x-nullable": true, "x-propertyPath": "GenerateExportProfileResult->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "GenerateExportProfileResult->ResourceAction" }, "module": { "title": "module", "type": "string", "x-nullable": true, "x-propertyPath": "GenerateExportProfileResult->Module" } } }, "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" } } }, "ExportLicenceKeyResourceActionResponse": { "title": "ExportLicenceKeyResourceActionResponse", "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": "ExportLicenceKeyResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "licence": { "title": "licence", "type": "string", "x-nullable": true, "x-propertyPath": "SignedLicenceKey->Licence" } } }, "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" } } }, "GenerateLicenceRequestResourceActionResponse": { "title": "GenerateLicenceRequestResourceActionResponse", "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": "GenerateLicenceRequestResourceActionResponseProperties", "type": "object", "x-nullable": false }, "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" } } }, "GetLicenceInfoResourceActionResponse": { "title": "GetLicenceInfoResourceActionResponse", "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": "GetLicenceInfoResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "licenceStatus": { "title": "licenceStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LicenceInfo->LicenceStatus", "x-formatSpecifier": "LicenceKeyLoadStatus" }, "licenceStatusDescription": { "title": "licenceStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceInfo->LicenceStatusDescription" }, "client": { "title": "client", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceInfo->Client" }, "environment": { "title": "environment", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceInfo->Environment" }, "generatedOn": { "title": "generatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LicenceInfo->GeneratedOn" } } }, "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" } } }, "GetLicenceMeasureInfoListResourceActionResponse": { "title": "GetLicenceMeasureInfoListResourceActionResponse", "type": "object", "properties": { "measure": { "title": "measure", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->Measure", "x-formatSpecifier": "LicenceMeasureType" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->Name" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->Category" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->IsActive" }, "lastMeasurement": { "title": "lastMeasurement", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->LastMeasurement" }, "currentValue": { "title": "currentValue", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->CurrentValue" }, "allowedLimit": { "title": "allowedLimit", "type": "string", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->AllowedLimit" }, "healthStatus": { "title": "healthStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LicenceMeasureInfo->HealthStatus", "x-formatSpecifier": "SystemHealthStatus" }, "lastMeasuredOn": { "title": "lastMeasuredOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LicenceMeasureInfo->LastMeasuredOn" } } }, "GetLicenceMeasureInfoListResourceAction": { "title": "GetLicenceMeasureInfoListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Licence entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Licence entities", "items": { "$ref": "#/definitions/GetLicenceMeasureInfoListResourceActionResponse" } }, "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" } } }, "ImportLicenceKeyResourceActionRequest": { "title": "ImportLicenceKeyResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ImportLicenceKeyResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "certificate", "licence" ], "properties": { "certificate": { "title": "certificate", "type": "string", "x-nullable": false, "x-propertyPath": "SignedLicenceKey->Certificate" }, "licence": { "title": "licence", "type": "string", "x-nullable": false, "x-propertyPath": "SignedLicenceKey->Licence" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GetNotificationEventAttachmentOutboxCollectionResourceActionResponse": { "title": "GetNotificationEventAttachmentOutboxCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetNotificationEventAttachmentOutboxCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetNotificationEventAttachmentOutboxCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "attachmentId": { "title": "attachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->AttachmentId" }, "generatedOn": { "title": "generatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationEventAttachmentOutbox->GeneratedOn" }, "handled": { "title": "handled", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->Handled" }, "handledOn": { "title": "handledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationEventAttachmentOutbox->HandledOn" }, "response": { "title": "response", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->Response" }, "hasContent": { "title": "hasContent", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->HasContent" }, "eventOutboxId": { "title": "eventOutboxId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_Id" }, "eventOutboxHandled": { "title": "eventOutboxHandled", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_Handled" }, "eventOutboxNotificationSource": { "title": "eventOutboxNotificationSource", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_NotificationSource", "x-formatSpecifier": "NotificationSource" }, "eventOutboxNotificationOutputType": { "title": "eventOutboxNotificationOutputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_NotificationOutputType", "x-formatSpecifier": "NotificationOutputType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetNotificationEventAttachmentOutboxForNotificationEventOutboxCollectionResourceActionResponse": { "title": "GetNotificationEventAttachmentOutboxForNotificationEventOutboxCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetNotificationEventAttachmentOutboxForNotificationEventOutboxCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetNotificationEventAttachmentOutboxForNotificationEventOutboxCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "attachmentId": { "title": "attachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->AttachmentId" }, "generatedOn": { "title": "generatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationEventAttachmentOutbox->GeneratedOn" }, "handledOn": { "title": "handledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationEventAttachmentOutbox->HandledOn" }, "handled": { "title": "handled", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->Handled" }, "response": { "title": "response", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->Response" }, "hasContent": { "title": "hasContent", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->HasContent" }, "eventOutboxId": { "title": "eventOutboxId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_Id" }, "eventOutboxNotificationSource": { "title": "eventOutboxNotificationSource", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_NotificationSource", "x-formatSpecifier": "NotificationSource" }, "eventOutboxNotificationOutputType": { "title": "eventOutboxNotificationOutputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationEventAttachmentOutbox->EventOutbox_NotificationOutputType", "x-formatSpecifier": "NotificationOutputType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetNotificationEventOutboxCollectionResourceActionResponse": { "title": "GetNotificationEventOutboxCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetNotificationEventOutboxCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetNotificationEventOutboxCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notificationSource": { "title": "notificationSource", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->NotificationSource", "x-formatSpecifier": "NotificationSource" }, "notificationOutputType": { "title": "notificationOutputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->NotificationOutputType", "x-formatSpecifier": "NotificationOutputType" }, "attachmentCount": { "title": "attachmentCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->AttachmentCount" }, "attachmentRenderedCount": { "title": "attachmentRenderedCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->AttachmentRenderedCount" }, "generatedOn": { "title": "generatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationEventOutbox->GeneratedOn" }, "handled": { "title": "handled", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->Handled" }, "handledOn": { "title": "handledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationEventOutbox->HandledOn" }, "success": { "title": "success", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->Success" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->NotificationTemplate_Id" }, "notificationTemplateCode": { "title": "notificationTemplateCode", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationEventOutbox->NotificationTemplate_Code" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationEventOutbox->NotificationTemplate_Description" }, "ignoreTemplateAudience": { "title": "ignoreTemplateAudience", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->IgnoreTemplateAudience" }, "response": { "title": "response", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "NotificationEventOutbox->Response" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "NotificationEventOutbox": { "title": "NotificationEventOutbox", "type": "object", "properties": { "properties": { "title": "NotificationEventOutboxProperties", "type": "object", "x-nullable": false }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "IgnoreNotificationEventOutboxErrorsResourceActionRequest": { "title": "IgnoreNotificationEventOutboxErrorsResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/NotificationEventOutbox" } }, "RetryNotificationEventOutboxErrorsResourceActionRequest": { "title": "RetryNotificationEventOutboxErrorsResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/NotificationEventOutbox" } }, "GetNotificationOutboxCollectionResourceActionResponse": { "title": "GetNotificationOutboxCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetNotificationOutboxCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetNotificationOutboxCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "createdDate": { "title": "createdDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationOutbox->CreatedDate" }, "handledDate": { "title": "handledDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationOutbox->HandledDate" }, "handledStatus": { "title": "handledStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationOutbox->HandledStatus", "x-formatSpecifier": "NotificationHandledStatus" }, "mimeType": { "title": "mimeType", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationOutbox->MimeType" }, "outputType": { "title": "outputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationOutbox->OutputType", "x-formatSpecifier": "NotificationOutputType" }, "actualAudienceCount": { "title": "actualAudienceCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationOutbox->ActualAudienceCount" }, "skippedAudienceCount": { "title": "skippedAudienceCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationOutbox->SkippedAudienceCount" }, "invalidAudienceCount": { "title": "invalidAudienceCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationOutbox->InvalidAudienceCount" }, "attemptedAudienceCount": { "title": "attemptedAudienceCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationOutbox->AttemptedAudienceCount" }, "notificationEventId": { "title": "notificationEventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationOutbox->NotificationEvent_Id" }, "notificationEventAttachmentCount": { "title": "notificationEventAttachmentCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationOutbox->NotificationEvent_AttachmentCount" }, "notificationEventNotificationSource": { "title": "notificationEventNotificationSource", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationOutbox->NotificationEvent_NotificationSource", "x-formatSpecifier": "NotificationSource" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetNotificationOutboxLogForNotificationOutboxCollectionResourceActionResponse": { "title": "GetNotificationOutboxLogForNotificationOutboxCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetNotificationOutboxLogForNotificationOutboxCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetNotificationOutboxLogForNotificationOutboxCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "handledDate": { "title": "handledDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationOutboxLog->HandledDate" }, "success": { "title": "success", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationOutboxLog->Success" }, "response": { "title": "response", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "NotificationOutboxLog->Response" }, "outboxOutputType": { "title": "outboxOutputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationOutboxLog->Outbox_OutputType", "x-formatSpecifier": "NotificationOutputType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetNotificationOutboxLogCollectionResourceActionResponse": { "title": "GetNotificationOutboxLogCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetNotificationOutboxLogCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetNotificationOutboxLogCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "handledDate": { "title": "handledDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationOutboxLog->HandledDate" }, "success": { "title": "success", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationOutboxLog->Success" }, "response": { "title": "response", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "NotificationOutboxLog->Response" }, "outboxOutputType": { "title": "outboxOutputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationOutboxLog->Outbox_OutputType", "x-formatSpecifier": "NotificationOutputType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "NotificationOutboxLog": { "title": "NotificationOutboxLog", "type": "object", "properties": { "properties": { "title": "NotificationOutboxLogProperties", "type": "object", "x-nullable": false }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "IgnoreNotificationOutboxLogErrorsResourceActionRequest": { "title": "IgnoreNotificationOutboxLogErrorsResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/NotificationOutboxLog" } }, "ResendNotificationOutboxLogErrorsResourceActionRequest": { "title": "ResendNotificationOutboxLogErrorsResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/NotificationOutboxLog" } }, "GetScheduledBackgroundTaskResourceActionResponse": { "title": "GetScheduledBackgroundTaskResourceActionResponse", "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": "GetScheduledBackgroundTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->ModifiedOn" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "x-nullable": false, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ScheduledBackgroundTask->JobId" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->Name" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Notes" }, "onceOff": { "title": "onceOff", "type": "boolean", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->OnceOff" }, "request": { "title": "request", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->Request" }, "requestType": { "title": "requestType", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->RequestType" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Schedule" }, "startFrom": { "title": "startFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->StartFrom" }, "trace": { "title": "trace", "x-nullable": true, "$ref": "#/definitions/TraceContext", "x-propertyPath": "ScheduledBackgroundTask->Trace" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Type" } } }, "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" } } }, "GetScheduledBackgroundTaskCollectionResourceActionResponse": { "title": "GetScheduledBackgroundTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetScheduledBackgroundTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetScheduledBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->Name" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Type" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "x-nullable": false, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ScheduledBackgroundTask->JobId" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Schedule" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "startFrom": { "title": "startFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->StartFrom" }, "onceOff": { "title": "onceOff", "type": "boolean", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->OnceOff" }, "requestType": { "title": "requestType", "type": "string", "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->RequestType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->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" } } } }, "UpdateScheduledBackgroundTaskResourceActionRequest": { "title": "UpdateScheduledBackgroundTaskResourceActionRequest", "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": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Schedule" }, { "title": "startFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->StartFrom" }, { "title": "name", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ScheduledBackgroundTask->Name" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Notes" } ] } } }, "DeleteScheduledBackgroundTaskResourceActionRequest": { "title": "DeleteScheduledBackgroundTaskResourceActionRequest", "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 } } }, "BatchGetScheduledBackgroundTaskResourceAction": { "title": "BatchGetScheduledBackgroundTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Scheduled Background Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Scheduled Background Task entities", "items": { "$ref": "#/definitions/GetScheduledBackgroundTaskResourceActionResponse" } }, "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" } } }, "BatchUpdateScheduledBackgroundTaskResourceActionRequest": { "title": "BatchUpdateScheduledBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateScheduledBackgroundTaskResourceActionRequest" } }, "BatchDeleteScheduledBackgroundTaskResourceActionRequest": { "title": "BatchDeleteScheduledBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteScheduledBackgroundTaskResourceActionRequest" } }, "GetJobScheduleJobResourceActionResponse": { "title": "GetJobScheduleJobResourceActionResponse", "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": "GetJobScheduleJobResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Id" }, "backgroundTaskCompletedSteps": { "title": "backgroundTaskCompletedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_CompletedSteps" }, "backgroundTaskCompletedOn": { "title": "backgroundTaskCompletedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->BackgroundTask_CompletedOn" }, "backgroundTaskFailedSteps": { "title": "backgroundTaskFailedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_FailedSteps" }, "backgroundTaskCreatedByUserId": { "title": "backgroundTaskCreatedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_CreatedByUser_Id" }, "backgroundTaskCreatedByUserCode": { "title": "backgroundTaskCreatedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_CreatedByUser_Code" }, "backgroundTaskCreatedByUserFullName": { "title": "backgroundTaskCreatedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_CreatedByUser_FullName" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Name" }, "backgroundTaskOrigin": { "title": "backgroundTaskOrigin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "backgroundTaskPriority": { "title": "backgroundTaskPriority", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Priority" }, "backgroundTaskSkippedSteps": { "title": "backgroundTaskSkippedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_SkippedSteps" }, "backgroundTaskStartedOn": { "title": "backgroundTaskStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->BackgroundTask_StartedOn" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskTotalSteps": { "title": "backgroundTaskTotalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_TotalSteps" }, "backgroundTaskTrace": { "title": "backgroundTaskTrace", "x-nullable": true, "$ref": "#/definitions/TraceContext", "x-propertyPath": "ScheduledJob->BackgroundTask_Trace" }, "backgroundTaskType": { "title": "backgroundTaskType", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Type" }, "dispatchedOn": { "title": "dispatchedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->DispatchedOn" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ScheduledJob->JobId" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Name" }, "onceOff": { "title": "onceOff", "type": "boolean", "x-nullable": true, "x-propertyPath": "ScheduledJob->OnceOff" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->Origin", "x-formatSpecifier": "ScheduledJobOrigin" }, "request": { "title": "request", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Request" }, "requestType": { "title": "requestType", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->RequestType" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "ScheduledJob->Response" }, "runAsUserId": { "title": "runAsUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledJob->RunAsUser_Id" }, "runAsUserCode": { "title": "runAsUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->RunAsUser_Code" }, "runAsUserFullName": { "title": "runAsUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->RunAsUser_FullName" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Schedule" }, "scheduledOn": { "title": "scheduledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->ScheduledOn" }, "scheduleFrom": { "title": "scheduleFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->ScheduleFrom" }, "startOn": { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->StartOn" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->Status", "x-formatSpecifier": "ScheduledJobStatus" }, "trace": { "title": "trace", "x-nullable": true, "$ref": "#/definitions/TraceContext", "x-propertyPath": "ScheduledJob->Trace" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Type" } } }, "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" } } }, "GetJobListResourceActionResponse": { "title": "GetJobListResourceActionResponse", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "JobInfo->Description" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "JobInfo->JobId" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "JobInfo->Name" }, "canRunAdhoc": { "title": "canRunAdhoc", "type": "boolean", "x-nullable": true, "x-propertyPath": "JobInfo->CanRunAdhoc" }, "lastCompleted": { "title": "lastCompleted", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "JobInfo->LastCompleted" }, "lastQueued": { "title": "lastQueued", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "JobInfo->LastQueued" }, "lastRun": { "title": "lastRun", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "JobInfo->LastRun" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "JobInfo->Schedule" }, "scheduleDescription": { "title": "scheduleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "JobInfo->ScheduleDescription" } } }, "GetJobListResourceAction": { "title": "GetJobListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Scheduled Job entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Scheduled Job entities", "items": { "$ref": "#/definitions/GetJobListResourceActionResponse" } }, "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" } } }, "GetJobScheduleForJobCollectionResourceActionResponse": { "title": "GetJobScheduleForJobCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetJobScheduleForJobCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetJobScheduleForJobCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Name" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Type" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->Origin", "x-formatSpecifier": "ScheduledJobOrigin" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->Status", "x-formatSpecifier": "ScheduledJobStatus" }, "scheduledOn": { "title": "scheduledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->ScheduledOn" }, "dispatchedOn": { "title": "dispatchedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->DispatchedOn" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Schedule" }, "scheduleFrom": { "title": "scheduleFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->ScheduleFrom" }, "startOn": { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->StartOn" }, "onceOff": { "title": "onceOff", "type": "boolean", "x-nullable": true, "x-propertyPath": "ScheduledJob->OnceOff" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "requestType": { "title": "requestType", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->RequestType" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "ScheduledJob->Response" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Name" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskStartedOn": { "title": "backgroundTaskStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->BackgroundTask_StartedOn" }, "backgroundTaskCompletedOn": { "title": "backgroundTaskCompletedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->BackgroundTask_CompletedOn" }, "backgroundTaskTotalSteps": { "title": "backgroundTaskTotalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_TotalSteps" }, "backgroundTaskCompletedSteps": { "title": "backgroundTaskCompletedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_CompletedSteps" }, "backgroundTaskFailedSteps": { "title": "backgroundTaskFailedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_FailedSteps" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetJobScheduleJobCollectionResourceActionResponse": { "title": "GetJobScheduleJobCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetJobScheduleJobCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetJobScheduleJobCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Name" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Type" }, "origin": { "title": "origin", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->Origin", "x-formatSpecifier": "ScheduledJobOrigin" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->Status", "x-formatSpecifier": "ScheduledJobStatus" }, "scheduledOn": { "title": "scheduledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->ScheduledOn" }, "dispatchedOn": { "title": "dispatchedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->DispatchedOn" }, "schedule": { "title": "schedule", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->Schedule" }, "scheduleFrom": { "title": "scheduleFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->ScheduleFrom" }, "startOn": { "title": "startOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->StartOn" }, "onceOff": { "title": "onceOff", "type": "boolean", "x-nullable": true, "x-propertyPath": "ScheduledJob->OnceOff" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "requestType": { "title": "requestType", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->RequestType" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "ScheduledJob->Response" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ScheduledJob->JobId" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Name" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskStartedOn": { "title": "backgroundTaskStartedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->BackgroundTask_StartedOn" }, "backgroundTaskCompletedOn": { "title": "backgroundTaskCompletedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledJob->BackgroundTask_CompletedOn" }, "backgroundTaskTotalSteps": { "title": "backgroundTaskTotalSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_TotalSteps" }, "backgroundTaskCompletedSteps": { "title": "backgroundTaskCompletedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_CompletedSteps" }, "backgroundTaskFailedSteps": { "title": "backgroundTaskFailedSteps", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ScheduledJob->BackgroundTask_FailedSteps" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetChangeDataSubscriptionOutboxErrorLogListResourceActionResponse": { "title": "GetChangeDataSubscriptionOutboxErrorLogListResourceActionResponse", "type": "object", "properties": { "publishedDate": { "title": "publishedDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->PublishedDate" }, "createdDate": { "title": "createdDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->CreatedDate" }, "error": { "title": "error", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->Error" }, "changeDataSubscriptionOutboxErrorLogId": { "title": "changeDataSubscriptionOutboxErrorLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->ChangeDataSubscriptionOutboxErrorLogId" }, "messageId": { "title": "messageId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->MessageId" }, "topicName": { "title": "topicName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->TopicName" } } }, "GetChangeDataSubscriptionOutboxErrorLogListResourceAction": { "title": "GetChangeDataSubscriptionOutboxErrorLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetChangeDataSubscriptionOutboxErrorLogListResourceActionResponse" } }, "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" } } }, "GetConversionLogListResourceActionResponse": { "title": "GetConversionLogListResourceActionResponse", "type": "object", "properties": { "createdDate": { "title": "createdDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ConversionLog->CreatedDate" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "ConversionLog->Message" }, "sourceId": { "title": "sourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ConversionLog->SourceId" }, "sourceScope": { "title": "sourceScope", "type": "string", "x-nullable": true, "x-propertyPath": "ConversionLog->SourceScope" }, "targetId": { "title": "targetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ConversionLog->TargetId" }, "targetScope": { "title": "targetScope", "type": "string", "x-nullable": true, "x-propertyPath": "ConversionLog->TargetScope" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ConversionLog->Id" } } }, "GetConversionLogListResourceAction": { "title": "GetConversionLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetConversionLogListResourceActionResponse" } }, "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" } } }, "GetDomainEventOutboxErrorLogListResourceActionResponse": { "title": "GetDomainEventOutboxErrorLogListResourceActionResponse", "type": "object", "properties": { "handledOn": { "title": "handledOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "DomainEventOutboxErrorLog->HandledOn" }, "error": { "title": "error", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "DomainEventOutboxErrorLog->Error" }, "domainEventErrorLogId": { "title": "domainEventErrorLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DomainEventOutboxErrorLog->DomainEventErrorLogId" }, "domainEventId": { "title": "domainEventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "DomainEventOutboxErrorLog->DomainEventId" }, "domainEventName": { "title": "domainEventName", "type": "string", "x-nullable": true, "x-propertyPath": "DomainEventOutboxErrorLog->DomainEventName" }, "domainEventHandler": { "title": "domainEventHandler", "type": "string", "x-nullable": true, "x-propertyPath": "DomainEventOutboxErrorLog->DomainEventHandler" } } }, "GetDomainEventOutboxErrorLogListResourceAction": { "title": "GetDomainEventOutboxErrorLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetDomainEventOutboxErrorLogListResourceActionResponse" } }, "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" } } }, "GetDomainEventOutboxErrorLogListForDomainEventResourceAction": { "title": "GetDomainEventOutboxErrorLogListForDomainEventResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetDomainEventOutboxErrorLogListResourceActionResponse" } }, "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" } } }, "GetMessageOutboxErrorLogListResourceActionResponse": { "title": "GetMessageOutboxErrorLogListResourceActionResponse", "type": "object", "properties": { "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MessageOutboxErrorLog->ConsumedOn" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MessageOutboxErrorLog->CreatedOn" }, "error": { "title": "error", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "MessageOutboxErrorLog->Error" }, "messageId": { "title": "messageId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "MessageOutboxErrorLog->MessageId" }, "result": { "title": "result", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MessageOutboxErrorLog->Result", "x-formatSpecifier": "MessageConsumerResult" }, "consumerType": { "title": "consumerType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MessageOutboxErrorLog->ConsumerType", "x-formatSpecifier": "MessageConsumerType" } } }, "GetMessageOutboxErrorLogListForMessageResourceAction": { "title": "GetMessageOutboxErrorLogListForMessageResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetMessageOutboxErrorLogListResourceActionResponse" } }, "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" } } }, "GetMessageOutboxErrorLogListResourceAction": { "title": "GetMessageOutboxErrorLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetMessageOutboxErrorLogListResourceActionResponse" } }, "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" } } }, "GetMigrationLogResourceActionResponse": { "title": "GetMigrationLogResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->Id" }, "migrationId": { "title": "migrationId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "TenantMigrationLog->MigrationId" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "TenantMigrationLog->ElapsedTime" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->Name" }, "groupName": { "title": "groupName", "type": "string", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->GroupName" }, "response": { "title": "response", "x-nullable": true, "$ref": "#/definitions/NotificationSchema", "x-propertyPath": "TenantMigrationLog->Response" }, "responseIsValid": { "title": "responseIsValid", "type": "boolean", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->ResponseIsValid" }, "message": { "title": "message", "type": "string", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->Message" }, "onKeyBuildNumber": { "title": "onKeyBuildNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->OnKeyBuildNumber" }, "onKeyVersionNumber": { "title": "onKeyVersionNumber", "type": "string", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->OnKeyVersionNumber" }, "runOn": { "title": "runOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TenantMigrationLog->RunOn" }, "database": { "title": "database", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TenantMigrationLog->Database", "x-formatSpecifier": "SourceDatabase" } } }, "GetMigrationLogListResourceAction": { "title": "GetMigrationLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetMigrationLogResourceActionResponse" } }, "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" } } }, "GetResourceActionMigrationLogResourceActionResponse": { "title": "GetResourceActionMigrationLogResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Id" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceActionMigrationLog->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceActionMigrationLog->ModifiedOn" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Version" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Action", "x-formatSpecifier": "MigrationLogAction" }, "customisationId": { "title": "customisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_Id" }, "customisationName": { "title": "customisationName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_Name" }, "customisationDescription": { "title": "customisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_Description" }, "customisationModule": { "title": "customisationModule", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_Module" }, "customisationResource": { "title": "customisationResource", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_Resource" }, "customisationResourceAction": { "title": "customisationResourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_ResourceAction" }, "customisationRestrictionLevel": { "title": "customisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Customisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "intent": { "title": "intent", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Intent" }, "intentType": { "title": "intentType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->IntentType", "x-formatSpecifier": "IntentType" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Message" }, "onKeyTargetVersionNumber": { "title": "onKeyTargetVersionNumber", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->OnKeyTargetVersionNumber" }, "runOn": { "title": "runOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceActionMigrationLog->RunOn" }, "success": { "title": "success", "type": "boolean", "x-nullable": true, "x-propertyPath": "ResourceActionMigrationLog->Success" } } }, "GetResourceActionMigrationLogListResourceAction": { "title": "GetResourceActionMigrationLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetResourceActionMigrationLogResourceActionResponse" } }, "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" } } }, "GetTemplateMigrationLogIntentListForMigrationResourceActionResponse": { "title": "GetTemplateMigrationLogIntentListForMigrationResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Version" }, "action": { "title": "action", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Action" }, "area": { "title": "area", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Area" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Description" }, "importance": { "title": "importance", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Importance", "x-formatSpecifier": "IntentImportance" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Message" }, "severity": { "title": "severity", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->Severity", "x-formatSpecifier": "IntentSeverity" }, "templateMigrationId": { "title": "templateMigrationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->TemplateMigration_Id" }, "templateMigrationMessage": { "title": "templateMigrationMessage", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->TemplateMigration_Message" }, "templateMigrationName": { "title": "templateMigrationName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->TemplateMigration_Name" }, "templateMigrationSuccess": { "title": "templateMigrationSuccess", "type": "boolean", "x-nullable": true, "x-propertyPath": "TemplateMigrationLogIntent->TemplateMigration_Success" }, "templateMigrationRunOn": { "title": "templateMigrationRunOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TemplateMigrationLogIntent->TemplateMigration_RunOn" } } }, "GetTemplateMigrationLogIntentListForMigrationResourceAction": { "title": "GetTemplateMigrationLogIntentListForMigrationResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetTemplateMigrationLogIntentListForMigrationResourceActionResponse" } }, "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" } } }, "GetTemplateMigrationLogResourceActionResponse": { "title": "GetTemplateMigrationLogResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Id" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TemplateMigrationLog->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TemplateMigrationLog->ModifiedOn" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Version" }, "action": { "title": "action", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Action", "x-formatSpecifier": "MigrationLogAction" }, "customisationId": { "title": "customisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_Id" }, "customisationDescription": { "title": "customisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_Description" }, "customisationModule": { "title": "customisationModule", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_Module" }, "customisationName": { "title": "customisationName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_Name" }, "customisationTemplate": { "title": "customisationTemplate", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_Template" }, "customisationType": { "title": "customisationType", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_Type" }, "customisationRestrictionLevel": { "title": "customisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "customisationCreatedByUserId": { "title": "customisationCreatedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_CreatedByUser_Id" }, "customisationCreatedByUserCode": { "title": "customisationCreatedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_CreatedByUser_Code" }, "customisationCreatedByUserFullName": { "title": "customisationCreatedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Customisation_CreatedByUser_FullName" }, "message": { "title": "message", "type": "string", "format": "memo", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Message" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Name" }, "onKeyTargetVersionNumber": { "title": "onKeyTargetVersionNumber", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->OnKeyTargetVersionNumber" }, "onKeyVersionNumber": { "title": "onKeyVersionNumber", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->OnKeyVersionNumber" }, "runOn": { "title": "runOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TemplateMigrationLog->RunOn" }, "success": { "title": "success", "type": "boolean", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->Success" }, "templateVersionNumber": { "title": "templateVersionNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TemplateMigrationLog->TemplateVersionNumber" } } }, "GetTemplateMigrationLogListResourceAction": { "title": "GetTemplateMigrationLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Logs entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Logs entities", "items": { "$ref": "#/definitions/GetTemplateMigrationLogResourceActionResponse" } }, "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" } } }, "ChangeDataSubscriptionOutboxErrorLog": { "title": "ChangeDataSubscriptionOutboxErrorLog", "type": "object", "properties": { "properties": { "title": "ChangeDataSubscriptionOutboxErrorLogProperties", "type": "object", "x-nullable": false, "required": [ "changeDataSubscriptionOutboxErrorLogId" ], "properties": { "changeDataSubscriptionOutboxErrorLogId": { "title": "changeDataSubscriptionOutboxErrorLogId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataSubscriptionOutboxErrorLog->ChangeDataSubscriptionOutboxErrorLogId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "IgnoreChangeDataSubscriptionOutboxErrorLogResourceActionRequest": { "title": "IgnoreChangeDataSubscriptionOutboxErrorLogResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeDataSubscriptionOutboxErrorLog" } }, "DomainEventOutboxErrorLog": { "title": "DomainEventOutboxErrorLog", "type": "object", "properties": { "properties": { "title": "DomainEventOutboxErrorLogProperties", "type": "object", "x-nullable": false, "required": [ "domainEventId" ], "properties": { "domainEventId": { "title": "domainEventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "DomainEventOutboxErrorLog->DomainEventId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "IgnoreDomainEventOutboxErrorLogResourceActionRequest": { "title": "IgnoreDomainEventOutboxErrorLogResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DomainEventOutboxErrorLog" } }, "MessageOutboxErrorLog": { "title": "MessageOutboxErrorLog", "type": "object", "properties": { "properties": { "title": "MessageOutboxErrorLogProperties", "type": "object", "x-nullable": false, "required": [ "messageId", "consumerType" ], "properties": { "messageId": { "title": "messageId", "type": "string", "format": "uuid", "x-nullable": false, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "MessageOutboxErrorLog->MessageId" }, "consumerType": { "title": "consumerType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "MessageOutboxErrorLog->ConsumerType", "x-formatSpecifier": "MessageConsumerType" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "IgnoreMessageOutboxErrorLogResourceActionRequest": { "title": "IgnoreMessageOutboxErrorLogResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/MessageOutboxErrorLog" } }, "ReplayDomainEventOutboxErrorLogResourceActionRequest": { "title": "ReplayDomainEventOutboxErrorLogResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DomainEventOutboxErrorLog" } }, "ReplayMessageOutboxErrorLogResourceActionRequest": { "title": "ReplayMessageOutboxErrorLogResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/MessageOutboxErrorLog" } }, "TemplateMigrationLog": { "title": "TemplateMigrationLog", "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" } } } }, "RestoreDefaultTemplateMigrationLogResourceActionRequest": { "title": "RestoreDefaultTemplateMigrationLogResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/TemplateMigrationLog" } }, "GetSystemOptionAMPCModuleResourceActionResponse": { "title": "GetSystemOptionAMPCModuleResourceActionResponse", "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": "GetSystemOptionAMPCModuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "allowDuplicateTaskLabour": { "title": "allowDuplicateTaskLabour", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDuplicateTaskLabour" }, "alwaysAllowMultipleOptionValues": { "title": "alwaysAllowMultipleOptionValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AlwaysAllowMultipleOptionValues" }, "allowDuplicateTaskSpares": { "title": "allowDuplicateTaskSpares", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDuplicateTaskSpares" } } }, "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" } } }, "GetSystemOptionAOMModuleResourceActionResponse": { "title": "GetSystemOptionAOMModuleResourceActionResponse", "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": "GetSystemOptionAOMModuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "averageDailyRateVariancePercentage": { "title": "averageDailyRateVariancePercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SystemOption->AverageDailyRateVariancePercentage" }, "alignAssetTasksAfterMeterReset": { "title": "alignAssetTasksAfterMeterReset", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AlignAssetTasksAfterMeterReset" }, "validateAverageDailyRateVariancePercentage": { "title": "validateAverageDailyRateVariancePercentage", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ValidateAverageDailyRateVariancePercentage" } } }, "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" } } }, "GetSystemOptionFINModuleResourceActionResponse": { "title": "GetSystemOptionFINModuleResourceActionResponse", "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": "GetSystemOptionFINModuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "enableCosting": { "title": "enableCosting", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableCosting" } } }, "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" } } }, "GetSystemOptionMMModuleResourceActionResponse": { "title": "GetSystemOptionMMModuleResourceActionResponse", "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": "GetSystemOptionMMModuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "allowIssuingOnClosedRequisition": { "title": "allowIssuingOnClosedRequisition", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowIssuingOnClosedRequisition" }, "allowStockAndNonStockOnTheSameRequisition": { "title": "allowStockAndNonStockOnTheSameRequisition", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowStockAndNonStockOnTheSameRequisition" }, "autoCreateRequisitionsOnScheduledWorkOrders": { "title": "autoCreateRequisitionsOnScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCreateRequisitionsOnScheduledWorkOrders" }, "defaultNewRequisitionStatusId": { "title": "defaultNewRequisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultNewRequisitionStatus_Id" }, "defaultRequisitionStatusWhenIssuedToCompletionId": { "title": "defaultRequisitionStatusWhenIssuedToCompletionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Id" }, "enableRequisitions": { "title": "enableRequisitions", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableRequisitions" }, "enableRequisitionApprovalWorkflow": { "title": "enableRequisitionApprovalWorkflow", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableRequisitionApprovalWorkflow" }, "useUserRequisitionLimits": { "title": "useUserRequisitionLimits", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->UseUserRequisitionLimits" }, "requisitionCodePrefix": { "title": "requisitionCodePrefix", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->RequisitionCodePrefix" }, "requisitionCodeLength": { "title": "requisitionCodeLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->RequisitionCodeLength" } } }, "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" } } }, "GetSystemOptionResourceActionResponse": { "title": "GetSystemOptionResourceActionResponse", "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": "GetSystemOptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOption->ModifiedOn" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ReportServerReportLanguage" }, "reportServerReportLanguageDisplayName": { "title": "reportServerReportLanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ReportServerReportLanguageDisplayName" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ReportServerUILanguage" }, "reportServerUILanguageDisplayName": { "title": "reportServerUILanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ReportServerUILanguageDisplayName" }, "allowCaseSensitiveCodeFields": { "title": "allowCaseSensitiveCodeFields", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowCaseSensitiveCodeFields" }, "allowDuplicateTaskLabour": { "title": "allowDuplicateTaskLabour", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDuplicateTaskLabour" }, "allowDuplicateTaskSpares": { "title": "allowDuplicateTaskSpares", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDuplicateTaskSpares" }, "alwaysAllowMultipleOptionValues": { "title": "alwaysAllowMultipleOptionValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AlwaysAllowMultipleOptionValues" }, "aOMModuleId": { "title": "aOMModuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->AOMModuleId" }, "alignAssetTasksAfterMeterReset": { "title": "alignAssetTasksAfterMeterReset", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AlignAssetTasksAfterMeterReset" }, "averageDailyRateVariancePercentage": { "title": "averageDailyRateVariancePercentage", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SystemOption->AverageDailyRateVariancePercentage" }, "validateAverageDailyRateVariancePercentage": { "title": "validateAverageDailyRateVariancePercentage", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ValidateAverageDailyRateVariancePercentage" }, "autoUpperCaseCodes": { "title": "autoUpperCaseCodes", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoUpperCaseCodes" }, "baseCurrencyId": { "title": "baseCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->BaseCurrency_Id" }, "baseCurrencyCode": { "title": "baseCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->BaseCurrency_Code" }, "baseCurrencyDescription": { "title": "baseCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->BaseCurrency_Description" }, "companyName": { "title": "companyName", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOption->CompanyName" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ContentTranslate" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "defaultAssetDevelopmentStatusApplyToChildren": { "title": "defaultAssetDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultAssetDevelopmentStatusApplyToChildren" }, "defaultAssetTypeDevelopmentStatusApplyToChildren": { "title": "defaultAssetTypeDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultAssetTypeDevelopmentStatusApplyToChildren" }, "defaultAssetTypeDevelopmentStatusApplyToDescendants": { "title": "defaultAssetTypeDevelopmentStatusApplyToDescendants", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultAssetTypeDevelopmentStatusApplyToDescendants" }, "defaultCreateSaveAction": { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "defaultFirstWeekOfTheYear": { "title": "defaultFirstWeekOfTheYear", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultFirstWeekOfTheYear", "x-formatSpecifier": "DefaultFirstWeekOfTheYear" }, "defaultIsActiveApplyToChildren": { "title": "defaultIsActiveApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultIsActiveApplyToChildren" }, "defaultIsActiveApplyToDescendants": { "title": "defaultIsActiveApplyToDescendants", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultIsActiveApplyToDescendants" }, "defaultIsActiveApplyToDetails": { "title": "defaultIsActiveApplyToDetails", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultIsActiveApplyToDetails" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultLanguage_Id" }, "defaultLanguageCode": { "title": "defaultLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultLanguage_Code" }, "defaultLanguageDescription": { "title": "defaultLanguageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultLanguage_Description" }, "defaultPageLimit": { "title": "defaultPageLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultPageLimit" }, "defaultResourceDurationUnitOfMeasurement": { "title": "defaultResourceDurationUnitOfMeasurement", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultResourceDurationUnitOfMeasurement" }, "defaultSyncDevelopmentStatusApplyToChildren": { "title": "defaultSyncDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultSyncDevelopmentStatusApplyToChildren" }, "defaultTradeLookup": { "title": "defaultTradeLookup", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultTradeLookup", "x-formatSpecifier": "DefaultTradeLookup" }, "defaultUpdateSaveAction": { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "displayMultipleCurrencyFields": { "title": "displayMultipleCurrencyFields", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DisplayMultipleCurrencyFields" }, "fINModuleId": { "title": "fINModuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->FINModuleId" }, "enableCosting": { "title": "enableCosting", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableCosting" }, "mMModuleId": { "title": "mMModuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->MMModuleId" }, "allowIssuingOnClosedRequisition": { "title": "allowIssuingOnClosedRequisition", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowIssuingOnClosedRequisition" }, "allowStockAndNonStockOnTheSameRequisition": { "title": "allowStockAndNonStockOnTheSameRequisition", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowStockAndNonStockOnTheSameRequisition" }, "autoCreateRequisitionsOnScheduledWorkOrders": { "title": "autoCreateRequisitionsOnScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCreateRequisitionsOnScheduledWorkOrders" }, "defaultNewRequisitionStatusId": { "title": "defaultNewRequisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultNewRequisitionStatus_Id" }, "defaultNewRequisitionStatusCode": { "title": "defaultNewRequisitionStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultNewRequisitionStatus_Code" }, "defaultNewRequisitionStatusDescription": { "title": "defaultNewRequisitionStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultNewRequisitionStatus_Description" }, "defaultRequisitionStatusWhenIssuedToCompletionId": { "title": "defaultRequisitionStatusWhenIssuedToCompletionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Id" }, "defaultRequisitionStatusWhenIssuedToCompletionCode": { "title": "defaultRequisitionStatusWhenIssuedToCompletionCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Code" }, "defaultRequisitionStatusWhenIssuedToCompletionDescription": { "title": "defaultRequisitionStatusWhenIssuedToCompletionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Description" }, "enableRequisitions": { "title": "enableRequisitions", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableRequisitions" }, "enableRequisitionApprovalWorkflow": { "title": "enableRequisitionApprovalWorkflow", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableRequisitionApprovalWorkflow" }, "requisitionCodeLength": { "title": "requisitionCodeLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->RequisitionCodeLength" }, "requisitionCodePrefix": { "title": "requisitionCodePrefix", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->RequisitionCodePrefix" }, "useUserRequisitionLimits": { "title": "useUserRequisitionLimits", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->UseUserRequisitionLimits" }, "supportEmail": { "title": "supportEmail", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->SupportEmail" }, "supportPerson": { "title": "supportPerson", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->SupportPerson" }, "supportPhoneNumber": { "title": "supportPhoneNumber", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->SupportPhoneNumber" }, "synchroniseSiteTreeWithPermissionTree": { "title": "synchroniseSiteTreeWithPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->SynchroniseSiteTreeWithPermissionTree" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "allowContractorItems": { "title": "allowContractorItems", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowContractorItems" }, "allowDirectPurchaseItems": { "title": "allowDirectPurchaseItems", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDirectPurchaseItems" }, "allowNoLabourFeedbackOnClosedWorkOrders": { "title": "allowNoLabourFeedbackOnClosedWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowNoLabourFeedbackOnClosedWorkOrders" }, "allowTaskSpareDeletes": { "title": "allowTaskSpareDeletes", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowTaskSpareDeletes" }, "allowWorkOrdersWithoutAssets": { "title": "allowWorkOrdersWithoutAssets", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowWorkOrdersWithoutAssets" }, "applySuppressionOnSplitAndMergeAction": { "title": "applySuppressionOnSplitAndMergeAction", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ApplySuppressionOnSplitAndMergeAction" }, "assetImportanceWeight": { "title": "assetImportanceWeight", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SystemOption->AssetImportanceWeight" }, "autoCalculateEstimatedDowntimeForFollowUpWorkOrders": { "title": "autoCalculateEstimatedDowntimeForFollowUpWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDowntimeForFollowUpWorkOrders" }, "autoCalculateEstimatedDowntimeForManualWorkOrders": { "title": "autoCalculateEstimatedDowntimeForManualWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDowntimeForManualWorkOrders" }, "autoCalculateEstimatedDowntimeForScheduledWorkOrders": { "title": "autoCalculateEstimatedDowntimeForScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDowntimeForScheduledWorkOrders" }, "autoCalculateEstimatedDurationForFollowUpWorkOrders": { "title": "autoCalculateEstimatedDurationForFollowUpWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDurationForFollowUpWorkOrders" }, "autoCalculateEstimatedDurationForManualWorkOrders": { "title": "autoCalculateEstimatedDurationForManualWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDurationForManualWorkOrders" }, "autoCalculateEstimatedDurationForScheduledWorkOrders": { "title": "autoCalculateEstimatedDurationForScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDurationForScheduledWorkOrders" }, "autoPopulateStartOnAndCompleteByDates": { "title": "autoPopulateStartOnAndCompleteByDates", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoPopulateStartOnAndCompleteByDates" }, "autoUpdateCompletedOnDate": { "title": "autoUpdateCompletedOnDate", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoUpdateCompletedOnDate" }, "calculateScheduledMetersFieldOnWorkOrders": { "title": "calculateScheduledMetersFieldOnWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CalculateScheduledMetersFieldOnWorkOrders" }, "checkStatusChangeWhenComplete": { "title": "checkStatusChangeWhenComplete", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CheckStatusChangeWhenComplete" }, "combineResourcesOnSingleTask": { "title": "combineResourcesOnSingleTask", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->CombineResourcesOnSingleTask", "x-formatSpecifier": "SystemOptionGenerateWorkOrderCombineResourcesOnSingleTask" }, "completeByDateCustomised": { "title": "completeByDateCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CompleteByDateCustomised" }, "contractorItemsCodesMandatory": { "title": "contractorItemsCodesMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ContractorItemsCodesMandatory" }, "defaultStatusId": { "title": "defaultStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->DefaultStatus_Id" }, "defaultStatusCode": { "title": "defaultStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultStatus_Code" }, "defaultStatusDescription": { "title": "defaultStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultStatus_Description" }, "defaultWorkRequestAwaitingApprovalStatusId": { "title": "defaultWorkRequestAwaitingApprovalStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Id" }, "defaultWorkRequestAwaitingApprovalStatusCode": { "title": "defaultWorkRequestAwaitingApprovalStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Code" }, "defaultWorkRequestAwaitingApprovalStatusDescription": { "title": "defaultWorkRequestAwaitingApprovalStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Description" }, "defaultWorkRequestCancelledStatusId": { "title": "defaultWorkRequestCancelledStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestCancelledStatus_Id" }, "defaultWorkRequestCancelledStatusCode": { "title": "defaultWorkRequestCancelledStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestCancelledStatus_Code" }, "defaultWorkRequestCancelledStatusDescription": { "title": "defaultWorkRequestCancelledStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestCancelledStatus_Description" }, "defaultWorkRequestClosedStatusId": { "title": "defaultWorkRequestClosedStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestClosedStatus_Id" }, "defaultWorkRequestClosedStatusCode": { "title": "defaultWorkRequestClosedStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestClosedStatus_Code" }, "defaultWorkRequestClosedStatusDescription": { "title": "defaultWorkRequestClosedStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestClosedStatus_Description" }, "dueCalendarTasksLookBackPeriod": { "title": "dueCalendarTasksLookBackPeriod", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "SystemOption->DueCalendarTasksLookBackPeriod" }, "dueTasksFutureRange": { "title": "dueTasksFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->DueTasksFutureRange" }, "enableSla": { "title": "enableSla", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableSla" }, "enforceAssetWarranty": { "title": "enforceAssetWarranty", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnforceAssetWarranty" }, "failureAnalysisCustomised": { "title": "failureAnalysisCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FailureAnalysisCustomised" }, "followUpTaskResponsibility": { "title": "followUpTaskResponsibility", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpTaskResponsibility", "x-formatSpecifier": "SystemOptionWorkOrderFollowUpTaskResponsibilityType" }, "followUpWorkOrderCatchStatus": { "title": "followUpWorkOrderCatchStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderCatchStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "followUpWorkOrderCustomised": { "title": "followUpWorkOrderCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderCustomised" }, "followUpWorkOrderTasksGroupBySection": { "title": "followUpWorkOrderTasksGroupBySection", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTasksGroupBySection" }, "followUpWorkOrderTasksGroupByTrade": { "title": "followUpWorkOrderTasksGroupByTrade", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTasksGroupByTrade" }, "followUpWorkOrderTypeOfWorkId": { "title": "followUpWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_Id" }, "followUpWorkOrderTypeOfWorkCode": { "title": "followUpWorkOrderTypeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_Code" }, "followUpWorkOrderTypeOfWorkDescription": { "title": "followUpWorkOrderTypeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_Description" }, "followUpWorkOrderTypeOfWorkWorkClass": { "title": "followUpWorkOrderTypeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "followUpWorkOrderTypeOfWorkWorkType": { "title": "followUpWorkOrderTypeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "labourRequiredCustomised": { "title": "labourRequiredCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->LabourRequiredCustomised" }, "mandatoryTasksCustomised": { "title": "mandatoryTasksCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->MandatoryTasksCustomised" }, "mergeAllowedWorkOrderStatus": { "title": "mergeAllowedWorkOrderStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAllowedWorkOrderStatus", "x-formatSpecifier": "SystemOptionMergeAllowedWorkOrderStatus" }, "mergeAndSplitCancelledWorkOrderStatusId": { "title": "mergeAndSplitCancelledWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitCancelledWorkOrderStatus_Id" }, "mergeAndSplitCancelledWorkOrderStatusCode": { "title": "mergeAndSplitCancelledWorkOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitCancelledWorkOrderStatus_Code" }, "mergeAndSplitCancelledWorkOrderStatusDescription": { "title": "mergeAndSplitCancelledWorkOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitCancelledWorkOrderStatus_Description" }, "mergeAndSplitInformationOnWorkOrder": { "title": "mergeAndSplitInformationOnWorkOrder", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitInformationOnWorkOrder" }, "mergeResourcesOnDuplicateAssetTasks": { "title": "mergeResourcesOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeResourcesOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeResourcesOnDuplicateStandardTasks": { "title": "mergeResourcesOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeResourcesOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSparesOnDuplicateAssetTasks": { "title": "mergeSparesOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSparesOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSparesOnDuplicateStandardTasks": { "title": "mergeSparesOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSparesOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSubTasksOnDuplicateAssetTasks": { "title": "mergeSubTasksOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSubTasksOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSubTasksOnDuplicateStandardTasks": { "title": "mergeSubTasksOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSubTasksOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeTypeOfWorkOption": { "title": "mergeTypeOfWorkOption", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeTypeOfWorkOption", "x-formatSpecifier": "SystemOptionMergeTypeOfWorkOption" }, "permitNumberCustomised": { "title": "permitNumberCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->PermitNumberCustomised" }, "predictedMeterReadingsLookBackPeriod": { "title": "predictedMeterReadingsLookBackPeriod", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "SystemOption->PredictedMeterReadingsLookBackPeriod" }, "priorityBasedOn": { "title": "priorityBasedOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->PriorityBasedOn", "x-formatSpecifier": "WorkOrderPriorityBasedOn" }, "proposedWorkDefaultGroupingInterval": { "title": "proposedWorkDefaultGroupingInterval", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkDefaultGroupingInterval" }, "proposedWorkDefaultTaskGroupingStartDate": { "title": "proposedWorkDefaultTaskGroupingStartDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOption->ProposedWorkDefaultTaskGroupingStartDate" }, "proposedWorkOrderDescription": { "title": "proposedWorkOrderDescription", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderDescription", "x-formatSpecifier": "SystemOptionProposedWorkOrderDescription" }, "proposedWorkOrderScheduledWorkOrderStatusId": { "title": "proposedWorkOrderScheduledWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Id" }, "proposedWorkOrderScheduledWorkOrderStatusCode": { "title": "proposedWorkOrderScheduledWorkOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Code" }, "proposedWorkOrderScheduledWorkOrderStatusDescription": { "title": "proposedWorkOrderScheduledWorkOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Description" }, "proposedWorkOrdersFutureRange": { "title": "proposedWorkOrdersFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrdersFutureRange" }, "scheduledWorkOrderCodePrefix": { "title": "scheduledWorkOrderCodePrefix", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOption->ScheduledWorkOrderCodePrefix" }, "standardTaskAddedCustomised": { "title": "standardTaskAddedCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->StandardTaskAddedCustomised" }, "startOnDateCustomised": { "title": "startOnDateCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->StartOnDateCustomised" }, "taskImportanceWeight": { "title": "taskImportanceWeight", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SystemOption->TaskImportanceWeight" }, "typeOfWorkReadOnlyCustomised": { "title": "typeOfWorkReadOnlyCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->TypeOfWorkReadOnlyCustomised" }, "unscheduledWorkOrderCodePrefix": { "title": "unscheduledWorkOrderCodePrefix", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOption->UnscheduledWorkOrderCodePrefix" }, "validateWorkOrderTaskCompletedReason": { "title": "validateWorkOrderTaskCompletedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->ValidateWorkOrderTaskCompletedReason", "x-formatSpecifier": "ValidateWorkOrderTaskCompletedReason" }, "verifyOutstandingDelayedSideEffects": { "title": "verifyOutstandingDelayedSideEffects", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->VerifyOutstandingDelayedSideEffects" }, "workOrderCodeLength": { "title": "workOrderCodeLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderCodeLength" }, "workOrderCodeReadOnlyCustomised": { "title": "workOrderCodeReadOnlyCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderCodeReadOnlyCustomised" }, "workOrderImportanceWeight": { "title": "workOrderImportanceWeight", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SystemOption->WorkOrderImportanceWeight" }, "workOrderMeterScheduledReadingMaintain": { "title": "workOrderMeterScheduledReadingMaintain", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderMeterScheduledReadingMaintain" }, "workOrderMeterScheduledReadingMethod": { "title": "workOrderMeterScheduledReadingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderMeterScheduledReadingMethod", "x-formatSpecifier": "SystemOptionWorkOrderMeterScheduledReadingMethod" }, "workOrderTaskAutomaticallyCreateMeterReading": { "title": "workOrderTaskAutomaticallyCreateMeterReading", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderTaskAutomaticallyCreateMeterReading" }, "workOrderTaskResourceAutomaticallyAssignResource": { "title": "workOrderTaskResourceAutomaticallyAssignResource", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderTaskResourceAutomaticallyAssignResource" }, "workPerformedEditableBaseStatus": { "title": "workPerformedEditableBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->WorkPerformedEditableBaseStatus", "x-formatSpecifier": "WorkPerformedEditableBaseStatus" }, "workPerformedRequiredCustomised": { "title": "workPerformedRequiredCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkPerformedRequiredCustomised" }, "workRequestCodeLength": { "title": "workRequestCodeLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestCodeLength" }, "workRequestCodePrefix": { "title": "workRequestCodePrefix", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestCodePrefix" }, "workRequestUseIdAsCode": { "title": "workRequestUseIdAsCode", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestUseIdAsCode" } } }, "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" } } }, "GetSystemOptionWMModuleResourceActionResponse": { "title": "GetSystemOptionWMModuleResourceActionResponse", "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": "GetSystemOptionWMModuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "allowDirectPurchaseItems": { "title": "allowDirectPurchaseItems", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDirectPurchaseItems" }, "allowContractorItems": { "title": "allowContractorItems", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowContractorItems" }, "contractorItemsCodesMandatory": { "title": "contractorItemsCodesMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ContractorItemsCodesMandatory" }, "allowTaskSpareDeletes": { "title": "allowTaskSpareDeletes", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowTaskSpareDeletes" }, "autoUpdateCompletedOnDate": { "title": "autoUpdateCompletedOnDate", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoUpdateCompletedOnDate" }, "startOnDateCustomised": { "title": "startOnDateCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->StartOnDateCustomised" }, "completeByDateCustomised": { "title": "completeByDateCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CompleteByDateCustomised" }, "defaultStatusId": { "title": "defaultStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->DefaultStatus_Id" }, "scheduledWorkOrderCodePrefix": { "title": "scheduledWorkOrderCodePrefix", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOption->ScheduledWorkOrderCodePrefix" }, "unscheduledWorkOrderCodePrefix": { "title": "unscheduledWorkOrderCodePrefix", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOption->UnscheduledWorkOrderCodePrefix" }, "workOrderCodeLength": { "title": "workOrderCodeLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderCodeLength" }, "workRequestCodeLength": { "title": "workRequestCodeLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestCodeLength" }, "workRequestCodePrefix": { "title": "workRequestCodePrefix", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestCodePrefix" }, "workRequestUseIdAsCode": { "title": "workRequestUseIdAsCode", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestUseIdAsCode" }, "failureAnalysisCustomised": { "title": "failureAnalysisCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FailureAnalysisCustomised" }, "workOrderTaskResourceAutomaticallyAssignResource": { "title": "workOrderTaskResourceAutomaticallyAssignResource", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderTaskResourceAutomaticallyAssignResource" }, "workPerformedEditableBaseStatus": { "title": "workPerformedEditableBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->WorkPerformedEditableBaseStatus", "x-formatSpecifier": "WorkPerformedEditableBaseStatus" }, "followUpWorkOrderTasksGroupBySection": { "title": "followUpWorkOrderTasksGroupBySection", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTasksGroupBySection" }, "mandatoryTasksCustomised": { "title": "mandatoryTasksCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->MandatoryTasksCustomised" }, "followUpWorkOrderCustomised": { "title": "followUpWorkOrderCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderCustomised" }, "followUpWorkOrderTypeOfWorkId": { "title": "followUpWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_Id" }, "typeOfWorkReadOnlyCustomised": { "title": "typeOfWorkReadOnlyCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->TypeOfWorkReadOnlyCustomised" }, "workOrderCodeReadOnlyCustomised": { "title": "workOrderCodeReadOnlyCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderCodeReadOnlyCustomised" }, "labourRequiredCustomised": { "title": "labourRequiredCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->LabourRequiredCustomised" }, "standardTaskAddedCustomised": { "title": "standardTaskAddedCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->StandardTaskAddedCustomised" }, "permitNumberCustomised": { "title": "permitNumberCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->PermitNumberCustomised" }, "followUpWorkOrderTasksGroupByTrade": { "title": "followUpWorkOrderTasksGroupByTrade", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTasksGroupByTrade" }, "followUpWorkOrderCatchStatus": { "title": "followUpWorkOrderCatchStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderCatchStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "mergeAndSplitCancelledWorkOrderStatusId": { "title": "mergeAndSplitCancelledWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitCancelledWorkOrderStatus_Id" }, "mergeSparesOnDuplicateAssetTasks": { "title": "mergeSparesOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSparesOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSparesOnDuplicateStandardTasks": { "title": "mergeSparesOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSparesOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeResourcesOnDuplicateAssetTasks": { "title": "mergeResourcesOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeResourcesOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeResourcesOnDuplicateStandardTasks": { "title": "mergeResourcesOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeResourcesOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSubTasksOnDuplicateAssetTasks": { "title": "mergeSubTasksOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSubTasksOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "mergeSubTasksOnDuplicateStandardTasks": { "title": "mergeSubTasksOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSubTasksOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, "applySuppressionOnSplitAndMergeAction": { "title": "applySuppressionOnSplitAndMergeAction", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ApplySuppressionOnSplitAndMergeAction" }, "mergeAndSplitInformationOnWorkOrder": { "title": "mergeAndSplitInformationOnWorkOrder", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitInformationOnWorkOrder" }, "workOrderTaskAutomaticallyCreateMeterReading": { "title": "workOrderTaskAutomaticallyCreateMeterReading", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderTaskAutomaticallyCreateMeterReading" }, "proposedWorkOrderScheduledWorkOrderStatusId": { "title": "proposedWorkOrderScheduledWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Id" }, "followUpTaskResponsibility": { "title": "followUpTaskResponsibility", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpTaskResponsibility", "x-formatSpecifier": "SystemOptionWorkOrderFollowUpTaskResponsibilityType" }, "proposedWorkOrderDescription": { "title": "proposedWorkOrderDescription", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderDescription", "x-formatSpecifier": "SystemOptionProposedWorkOrderDescription" }, "combineResourcesOnSingleTask": { "title": "combineResourcesOnSingleTask", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->CombineResourcesOnSingleTask", "x-formatSpecifier": "SystemOptionGenerateWorkOrderCombineResourcesOnSingleTask" }, "dueTasksFutureRange": { "title": "dueTasksFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->DueTasksFutureRange" }, "proposedWorkOrdersFutureRange": { "title": "proposedWorkOrdersFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrdersFutureRange" }, "predictedMeterReadingsLookBackPeriod": { "title": "predictedMeterReadingsLookBackPeriod", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "SystemOption->PredictedMeterReadingsLookBackPeriod" }, "dueCalendarTasksLookBackPeriod": { "title": "dueCalendarTasksLookBackPeriod", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "SystemOption->DueCalendarTasksLookBackPeriod" }, "proposedWorkDefaultGroupingInterval": { "title": "proposedWorkDefaultGroupingInterval", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkDefaultGroupingInterval" }, "proposedWorkDefaultTaskGroupingStartDate": { "title": "proposedWorkDefaultTaskGroupingStartDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOption->ProposedWorkDefaultTaskGroupingStartDate" }, "validateWorkOrderTaskCompletedReason": { "title": "validateWorkOrderTaskCompletedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->ValidateWorkOrderTaskCompletedReason", "x-formatSpecifier": "ValidateWorkOrderTaskCompletedReason" }, "workPerformedRequiredCustomised": { "title": "workPerformedRequiredCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkPerformedRequiredCustomised" }, "defaultWorkRequestAwaitingApprovalStatusId": { "title": "defaultWorkRequestAwaitingApprovalStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Id" }, "defaultWorkRequestClosedStatusId": { "title": "defaultWorkRequestClosedStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestClosedStatus_Id" }, "defaultWorkRequestCancelledStatusId": { "title": "defaultWorkRequestCancelledStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestCancelledStatus_Id" }, "enforceAssetWarranty": { "title": "enforceAssetWarranty", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnforceAssetWarranty" } } }, "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" } } }, "GetAllTypeOfWorkCollectionResourceActionResponse": { "title": "GetAllTypeOfWorkCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->Id" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" }, "workClass": { "title": "workClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkClass", "x-formatSpecifier": "WorkClass" } } }, "GetAllActiveTypeOfWorkCollectionResourceAction": { "title": "GetAllActiveTypeOfWorkCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option entities", "items": { "$ref": "#/definitions/GetAllTypeOfWorkCollectionResourceActionResponse" } }, "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" } } }, "GetAllActiveWorkOrderStatusCollectionResourceActionResponse": { "title": "GetAllActiveWorkOrderStatusCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->Id" }, "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" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ApplyStatusRestrictions" } } }, "GetAllActiveWorkOrderStatusCollectionResourceAction": { "title": "GetAllActiveWorkOrderStatusCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option entities", "items": { "$ref": "#/definitions/GetAllActiveWorkOrderStatusCollectionResourceActionResponse" } }, "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" } } }, "GetAllTypeOfWorkCollectionResourceAction": { "title": "GetAllTypeOfWorkCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option entities", "items": { "$ref": "#/definitions/GetAllTypeOfWorkCollectionResourceActionResponse" } }, "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" } } }, "GetAllWorkOrderStatusCollectionResourceActionResponse": { "title": "GetAllWorkOrderStatusCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->Id" }, "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" }, "applyStatusRestrictions": { "title": "applyStatusRestrictions", "type": "boolean", "x-nullable": true, "x-propertyPath": "WorkOrderStatus->ApplyStatusRestrictions" } } }, "GetAllWorkOrderStatusCollectionResourceAction": { "title": "GetAllWorkOrderStatusCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option entities", "items": { "$ref": "#/definitions/GetAllWorkOrderStatusCollectionResourceActionResponse" } }, "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" } } }, "SystemOptionBaseCurrencyLookupResourceActionResponse": { "title": "SystemOptionBaseCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SystemOptionBaseCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SystemOptionBaseCurrencyLookupResourceActionResponseItemProperties", "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" } } } }, "SystemOptionDefaultLanguageLookupResourceActionResponse": { "title": "SystemOptionDefaultLanguageLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SystemOptionDefaultLanguageLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SystemOptionDefaultLanguageLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Language->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" } } } }, "MMModuleOptionDefaultNewRequisitionStatusLookupResourceActionResponse": { "title": "MMModuleOptionDefaultNewRequisitionStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MMModuleOptionDefaultNewRequisitionStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "MMModuleOptionDefaultNewRequisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RequisitionStatus->BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletionLookupResourceActionResponse": { "title": "MMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "MMModuleOptionDefaultRequisitionStatusWhenIssuedToCompletionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RequisitionStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RequisitionStatus->BaseStatus", "x-formatSpecifier": "RequisitionStatusBaseStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "WMModuleOptionDefaultWorkOrderStatusLookupResourceActionResponse": { "title": "WMModuleOptionDefaultWorkOrderStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionDefaultWorkOrderStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionDefaultWorkOrderStatusLookupResourceActionResponseItemProperties", "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" } } } }, "WMModuleOptionDefaultWorkRequestAwaitingApprovalStatusLookupResourceActionResponse": { "title": "WMModuleOptionDefaultWorkRequestAwaitingApprovalStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionDefaultWorkRequestAwaitingApprovalStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionDefaultWorkRequestAwaitingApprovalStatusLookupResourceActionResponseItemProperties", "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" } } } }, "WMModuleOptionDefaultWorkRequestCancelledStatusLookupResourceResponse": { "title": "WMModuleOptionDefaultWorkRequestCancelledStatusLookupResourceResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionDefaultWorkRequestCancelledStatusLookupResourceResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionDefaultWorkRequestCancelledStatusLookupResourceResponseItemProperties", "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" } } } }, "WMModuleOptionDefaultWorkRequestClosedStatusLookupResourceActionResponse": { "title": "WMModuleOptionDefaultWorkRequestClosedStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionDefaultWorkRequestClosedStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionDefaultWorkRequestClosedStatusLookupResourceActionResponseItemProperties", "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" } } } }, "WMModuleOptionFollowUpWorkOrderTypeOfWorkLookupResourceActionResponse": { "title": "WMModuleOptionFollowUpWorkOrderTypeOfWorkLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionFollowUpWorkOrderTypeOfWorkLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionFollowUpWorkOrderTypeOfWorkLookupResourceActionResponseItemProperties", "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" } } } }, "WMModuleOptionMergeAndSplitCancelledWorkOrderStatusLookupResourceActionResponse": { "title": "WMModuleOptionMergeAndSplitCancelledWorkOrderStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionMergeAndSplitCancelledWorkOrderStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionMergeAndSplitCancelledWorkOrderStatusLookupResourceActionResponseItemProperties", "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" } } } }, "WMModuleOptionProposedWorkOrderScheduledWorkOrderStatusLookupResourceActionResponse": { "title": "WMModuleOptionProposedWorkOrderScheduledWorkOrderStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionProposedWorkOrderScheduledWorkOrderStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionProposedWorkOrderScheduledWorkOrderStatusLookupResourceActionResponseItemProperties", "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" } } } }, "UpdateSystemOptionResourceActionRequest": { "title": "UpdateSystemOptionResourceActionRequest", "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": "companyName", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "SystemOption->CompanyName" }, { "title": "allowDuplicateTaskLabour", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDuplicateTaskLabour" }, { "title": "allowDuplicateTaskSpares", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDuplicateTaskSpares" }, { "title": "alwaysAllowMultipleOptionValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AlwaysAllowMultipleOptionValues" }, { "title": "alignAssetTasksAfterMeterReset", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AlignAssetTasksAfterMeterReset" }, { "title": "validateAverageDailyRateVariancePercentage", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ValidateAverageDailyRateVariancePercentage" }, { "title": "averageDailyRateVariancePercentage", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "SystemOption->AverageDailyRateVariancePercentage" }, { "title": "allowCaseSensitiveCodeFields", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowCaseSensitiveCodeFields" }, { "title": "autoUpperCaseCodes", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoUpperCaseCodes" }, { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ContentTranslate" }, { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultLanguage_Id" }, { "title": "defaultPageLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "SystemOption->DefaultPageLimit" }, { "title": "defaultTradeLookup", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultTradeLookup", "x-formatSpecifier": "DefaultTradeLookup" }, { "title": "defaultFirstWeekOfTheYear", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultFirstWeekOfTheYear", "x-formatSpecifier": "DefaultFirstWeekOfTheYear" }, { "title": "displayMultipleCurrencyFields", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DisplayMultipleCurrencyFields" }, { "title": "reportServerReportLanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "SystemOption->ReportServerReportLanguage" }, { "title": "reportServerUILanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "SystemOption->ReportServerUILanguage" }, { "title": "synchroniseSiteTreeWithPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->SynchroniseSiteTreeWithPermissionTree" }, { "title": "defaultAssetTypeDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultAssetTypeDevelopmentStatusApplyToChildren" }, { "title": "defaultAssetTypeDevelopmentStatusApplyToDescendants", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultAssetTypeDevelopmentStatusApplyToDescendants" }, { "title": "defaultAssetDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultAssetDevelopmentStatusApplyToChildren" }, { "title": "defaultSyncDevelopmentStatusApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultSyncDevelopmentStatusApplyToChildren" }, { "title": "defaultIsActiveApplyToChildren", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultIsActiveApplyToChildren" }, { "title": "defaultIsActiveApplyToDescendants", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultIsActiveApplyToDescendants" }, { "title": "defaultIsActiveApplyToDetails", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultIsActiveApplyToDetails" }, { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, { "title": "supportPerson", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "SystemOption->SupportPerson" }, { "title": "supportPhoneNumber", "type": "string", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": true, "x-propertyPath": "SystemOption->SupportPhoneNumber" }, { "title": "supportEmail", "type": "string", "maxLength": 255, "x-nullable": true, "x-propertyPath": "SystemOption->SupportEmail" }, { "title": "enableCosting", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableCosting" }, { "title": "allowContractorItems", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowContractorItems" }, { "title": "allowDirectPurchaseItems", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowDirectPurchaseItems" }, { "title": "allowNoLabourFeedbackOnClosedWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowNoLabourFeedbackOnClosedWorkOrders" }, { "title": "allowTaskSpareDeletes", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowTaskSpareDeletes" }, { "title": "autoCalculateEstimatedDowntimeForFollowUpWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDowntimeForFollowUpWorkOrders" }, { "title": "autoCalculateEstimatedDowntimeForManualWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDowntimeForManualWorkOrders" }, { "title": "autoCalculateEstimatedDowntimeForScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDowntimeForScheduledWorkOrders" }, { "title": "autoCalculateEstimatedDurationForFollowUpWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDurationForFollowUpWorkOrders" }, { "title": "autoCalculateEstimatedDurationForManualWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDurationForManualWorkOrders" }, { "title": "autoCalculateEstimatedDurationForScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCalculateEstimatedDurationForScheduledWorkOrders" }, { "title": "autoUpdateCompletedOnDate", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoUpdateCompletedOnDate" }, { "title": "checkStatusChangeWhenComplete", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CheckStatusChangeWhenComplete" }, { "title": "combineResourcesOnSingleTask", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->CombineResourcesOnSingleTask", "x-formatSpecifier": "SystemOptionGenerateWorkOrderCombineResourcesOnSingleTask" }, { "title": "contractorItemsCodesMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ContractorItemsCodesMandatory" }, { "title": "defaultStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->DefaultStatus_Id" }, { "title": "dueCalendarTasksLookBackPeriod", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "SystemOption->DueCalendarTasksLookBackPeriod" }, { "title": "dueTasksFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->DueTasksFutureRange" }, { "title": "failureAnalysisCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FailureAnalysisCustomised" }, { "title": "followUpTaskResponsibility", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpTaskResponsibility", "x-formatSpecifier": "SystemOptionWorkOrderFollowUpTaskResponsibilityType" }, { "title": "followUpWorkOrderCatchStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderCatchStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, { "title": "followUpWorkOrderCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderCustomised" }, { "title": "followUpWorkOrderTasksGroupBySection", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTasksGroupBySection" }, { "title": "followUpWorkOrderTasksGroupByTrade", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->FollowUpWorkOrderTasksGroupByTrade" }, { "title": "followUpWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->FollowUpWorkOrderTypeOfWork_Id" }, { "title": "labourRequiredCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->LabourRequiredCustomised" }, { "title": "mandatoryTasksCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->MandatoryTasksCustomised" }, { "title": "mergeAndSplitCancelledWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitCancelledWorkOrderStatus_Id" }, { "title": "applySuppressionOnSplitAndMergeAction", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->ApplySuppressionOnSplitAndMergeAction" }, { "title": "mergeAndSplitInformationOnWorkOrder", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAndSplitInformationOnWorkOrder" }, { "title": "permitNumberCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->PermitNumberCustomised" }, { "title": "predictedMeterReadingsLookBackPeriod", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "SystemOption->PredictedMeterReadingsLookBackPeriod" }, { "title": "proposedWorkDefaultGroupingInterval", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkDefaultGroupingInterval" }, { "title": "proposedWorkDefaultTaskGroupingStartDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOption->ProposedWorkDefaultTaskGroupingStartDate" }, { "title": "proposedWorkOrderDescription", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderDescription", "x-formatSpecifier": "SystemOptionProposedWorkOrderDescription" }, { "title": "proposedWorkOrderScheduledWorkOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrderScheduledWorkOrderStatus_Id" }, { "title": "proposedWorkOrdersFutureRange", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOption->ProposedWorkOrdersFutureRange" }, { "title": "scheduledWorkOrderCodePrefix", "type": "string", "maxLength": 10, "minLength": 1, "x-nullable": false, "x-propertyPath": "SystemOption->ScheduledWorkOrderCodePrefix" }, { "title": "standardTaskAddedCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->StandardTaskAddedCustomised" }, { "title": "typeOfWorkReadOnlyCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->TypeOfWorkReadOnlyCustomised" }, { "title": "unscheduledWorkOrderCodePrefix", "type": "string", "maxLength": 10, "minLength": 1, "x-nullable": false, "x-propertyPath": "SystemOption->UnscheduledWorkOrderCodePrefix" }, { "title": "validateWorkOrderTaskCompletedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->ValidateWorkOrderTaskCompletedReason", "x-formatSpecifier": "ValidateWorkOrderTaskCompletedReason" }, { "title": "verifyOutstandingDelayedSideEffects", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->VerifyOutstandingDelayedSideEffects" }, { "title": "workOrderCodeLength", "type": "integer", "format": "int32", "maximum": 50.0, "minimum": 5.0, "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderCodeLength" }, { "title": "workRequestCodePrefix", "type": "string", "maxLength": 10, "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestCodePrefix" }, { "title": "workRequestCodeLength", "type": "integer", "format": "int32", "maximum": 50.0, "minimum": 4.0, "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestCodeLength" }, { "title": "workRequestUseIdAsCode", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkRequestUseIdAsCode" }, { "title": "workOrderCodeReadOnlyCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderCodeReadOnlyCustomised" }, { "title": "workOrderMeterScheduledReadingMaintain", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderMeterScheduledReadingMaintain" }, { "title": "calculateScheduledMetersFieldOnWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CalculateScheduledMetersFieldOnWorkOrders" }, { "title": "workOrderMeterScheduledReadingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderMeterScheduledReadingMethod", "x-formatSpecifier": "SystemOptionWorkOrderMeterScheduledReadingMethod" }, { "title": "workOrderTaskAutomaticallyCreateMeterReading", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderTaskAutomaticallyCreateMeterReading" }, { "title": "workOrderTaskResourceAutomaticallyAssignResource", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkOrderTaskResourceAutomaticallyAssignResource" }, { "title": "workPerformedEditableBaseStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->WorkPerformedEditableBaseStatus", "x-formatSpecifier": "WorkPerformedEditableBaseStatus" }, { "title": "workPerformedRequiredCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->WorkPerformedRequiredCustomised" }, { "title": "mergeAllowedWorkOrderStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeAllowedWorkOrderStatus", "x-formatSpecifier": "SystemOptionMergeAllowedWorkOrderStatus" }, { "title": "mergeTypeOfWorkOption", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeTypeOfWorkOption", "x-formatSpecifier": "SystemOptionMergeTypeOfWorkOption" }, { "title": "baseCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOption->BaseCurrency_Id" }, { "title": "defaultWorkRequestAwaitingApprovalStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestAwaitingApprovalStatus_Id" }, { "title": "defaultWorkRequestClosedStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestClosedStatus_Id" }, { "title": "defaultWorkRequestCancelledStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultWorkRequestCancelledStatus_Id" }, { "title": "allowIssuingOnClosedRequisition", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowIssuingOnClosedRequisition" }, { "title": "allowStockAndNonStockOnTheSameRequisition", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowStockAndNonStockOnTheSameRequisition" }, { "title": "autoCreateRequisitionsOnScheduledWorkOrders", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoCreateRequisitionsOnScheduledWorkOrders" }, { "title": "defaultNewRequisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultNewRequisitionStatus_Id" }, { "title": "defaultRequisitionStatusWhenIssuedToCompletionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultRequisitionStatusWhenIssuedToCompletion_Id" }, { "title": "mergeSparesOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSparesOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, { "title": "mergeSparesOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSparesOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, { "title": "mergeResourcesOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeResourcesOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, { "title": "mergeResourcesOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeResourcesOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, { "title": "mergeSubTasksOnDuplicateAssetTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSubTasksOnDuplicateAssetTasks", "x-formatSpecifier": "TaskDetailMergeType" }, { "title": "mergeSubTasksOnDuplicateStandardTasks", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOption->MergeSubTasksOnDuplicateStandardTasks", "x-formatSpecifier": "TaskDetailMergeType" }, { "title": "enableRequisitions", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableRequisitions" }, { "title": "enableRequisitionApprovalWorkflow", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableRequisitionApprovalWorkflow" }, { "title": "requisitionCodeLength", "type": "integer", "format": "int32", "maximum": 50.0, "minimum": 4.0, "x-nullable": true, "x-propertyPath": "SystemOption->RequisitionCodeLength" }, { "title": "requisitionCodePrefix", "type": "string", "maxLength": 10, "x-nullable": true, "x-propertyPath": "SystemOption->RequisitionCodePrefix" }, { "title": "useUserRequisitionLimits", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->UseUserRequisitionLimits" }, { "title": "defaultResourceDurationUnitOfMeasurement", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOption->DefaultResourceDurationUnitOfMeasurement" }, { "title": "allowWorkOrdersWithoutAssets", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AllowWorkOrdersWithoutAssets" }, { "title": "enableSla", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnableSla" }, { "title": "autoPopulateStartOnAndCompleteByDates", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->AutoPopulateStartOnAndCompleteByDates" }, { "title": "startOnDateCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->StartOnDateCustomised" }, { "title": "completeByDateCustomised", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->CompleteByDateCustomised" }, { "title": "priorityBasedOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOption->PriorityBasedOn", "x-formatSpecifier": "WorkOrderPriorityBasedOn" }, { "title": "assetImportanceWeight", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SystemOption->AssetImportanceWeight" }, { "title": "workOrderImportanceWeight", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SystemOption->WorkOrderImportanceWeight" }, { "title": "taskImportanceWeight", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SystemOption->TaskImportanceWeight" }, { "title": "enforceAssetWarranty", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOption->EnforceAssetWarranty" } ] } } }, "GetSystemOptionDefaultStandardTaskResourceActionResponse": { "title": "GetSystemOptionDefaultStandardTaskResourceActionResponse", "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": "GetSystemOptionDefaultStandardTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionDefaultStandardTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionDefaultStandardTask->ModifiedOn" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->SystemOption_Id" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_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" } } }, "GetSystemOptionDefaultStandardTaskCollectionResourceActionResponse": { "title": "GetSystemOptionDefaultStandardTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionDefaultStandardTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionDefaultStandardTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Description" }, "standardTaskSequenceNumber": { "title": "standardTaskSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_SequenceNumber" }, "standardTaskIsInspection": { "title": "standardTaskIsInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_IsInspection" }, "standardTaskImportanceDescription": { "title": "standardTaskImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Importance_Description" }, "standardTaskTypeOfWorkDescription": { "title": "standardTaskTypeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_TypeOfWork_Description" }, "standardTaskIntervalType1Description": { "title": "standardTaskIntervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_IntervalType1_Description" }, "standardTaskDefaultInterval1Description": { "title": "standardTaskDefaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_DefaultInterval1_Description" }, "standardTaskIntervalType2Description": { "title": "standardTaskIntervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_IntervalType2_Description" }, "standardTaskDefaultInterval2Description": { "title": "standardTaskDefaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_DefaultInterval2_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" } } } }, "WMModuleOptionDefaultStandardTaskStandardTaskLookupResourceActionResponse": { "title": "WMModuleOptionDefaultStandardTaskStandardTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WMModuleOptionDefaultStandardTaskStandardTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WMModuleOptionDefaultStandardTaskStandardTaskLookupResourceActionResponseItemProperties", "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateSystemOptionDefaultStandardTaskResourceActionRequest": { "title": "CreateSystemOptionDefaultStandardTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionDefaultStandardTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "standardTaskId" ], "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionDefaultStandardTask->StandardTask_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "DeleteSystemOptionDefaultStandardTaskResourceActionRequest": { "title": "DeleteSystemOptionDefaultStandardTaskResourceActionRequest", "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 } } }, "BatchGetSystemOptionDefaultStandardTaskResourceAction": { "title": "BatchGetSystemOptionDefaultStandardTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Default Standard Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Default Standard Task entities", "items": { "$ref": "#/definitions/GetSystemOptionDefaultStandardTaskResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionDefaultStandardTaskResourceActionRequest": { "title": "BatchCreateSystemOptionDefaultStandardTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionDefaultStandardTaskResourceActionRequest" } }, "BatchDeleteSystemOptionDefaultStandardTaskResourceActionRequest": { "title": "BatchDeleteSystemOptionDefaultStandardTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionDefaultStandardTaskResourceActionRequest" } }, "GetSystemOptionFileAttachmentCategoryResourceActionResponse": { "title": "GetSystemOptionFileAttachmentCategoryResourceActionResponse", "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": "GetSystemOptionFileAttachmentCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionFileAttachmentCategory->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionFileAttachmentCategory->ModifiedOn" }, "defaultFileAttachmentCategoryId": { "title": "defaultFileAttachmentCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id" }, "defaultFileAttachmentCategoryCode": { "title": "defaultFileAttachmentCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Code" }, "defaultFileAttachmentCategoryDescription": { "title": "defaultFileAttachmentCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Description" }, "defaultFileAttachmentCategoryAutoIsRestricted": { "title": "defaultFileAttachmentCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_AutoIsRestricted" }, "defaultFileCategoryLevel": { "title": "defaultFileCategoryLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel", "x-formatSpecifier": "DefaultFileCategoryLevelType" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->EntityType", "x-formatSpecifier": "EntityTypeFileAttachment" }, "fileType": { "title": "fileType", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->FileType", "x-NullExpression": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension'" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->SystemOption_Id" } } }, "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" } } }, "GetSystemOptionFileAttachmentCategoryCollectionResourceActionResponse": { "title": "GetSystemOptionFileAttachmentCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionFileAttachmentCategoryCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionFileAttachmentCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->EntityType", "x-formatSpecifier": "EntityTypeFileAttachment" }, "defaultFileAttachmentCategoryId": { "title": "defaultFileAttachmentCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id" }, "defaultFileAttachmentCategoryCode": { "title": "defaultFileAttachmentCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Code" }, "defaultFileAttachmentCategoryDescription": { "title": "defaultFileAttachmentCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Description" }, "defaultFileCategoryLevel": { "title": "defaultFileCategoryLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel", "x-formatSpecifier": "DefaultFileCategoryLevelType" }, "fileType": { "title": "fileType", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->FileType", "x-NullExpression": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq '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" } } } }, "DMModuleOptionAllowedFileExtensionLookupResourceActionResponse": { "title": "DMModuleOptionAllowedFileExtensionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "DMModuleOptionAllowedFileExtensionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "DMModuleOptionAllowedFileExtensionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "extension": { "title": "extension", "type": "string", "x-nullable": true, "x-propertyPath": "AllowedFileExtensionView->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" } } } }, "CreateSystemOptionFileAttachmentCategoryResourceActionRequest": { "title": "CreateSystemOptionFileAttachmentCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionFileAttachmentCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityType", "defaultFileAttachmentCategoryId" ], "properties": { "defaultFileCategoryLevel": { "title": "defaultFileCategoryLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel", "x-formatSpecifier": "DefaultFileCategoryLevelType" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->EntityType", "x-formatSpecifier": "EntityTypeFileAttachment" }, "fileType": { "title": "fileType", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->FileType", "x-NullExpression": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension'" }, "defaultFileAttachmentCategoryId": { "title": "defaultFileAttachmentCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSystemOptionFileAttachmentCategoryResourceActionRequest": { "title": "UpdateSystemOptionFileAttachmentCategoryResourceActionRequest", "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": "defaultFileCategoryLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel", "x-formatSpecifier": "DefaultFileCategoryLevelType" }, { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->EntityType", "x-formatSpecifier": "EntityTypeFileAttachment" }, { "title": "fileType", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->FileType", "x-NullExpression": "SystemOptionFileAttachmentCategory->DefaultFileCategoryLevel eq 'Extension'" }, { "title": "defaultFileAttachmentCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionFileAttachmentCategory->DefaultFileAttachmentCategory_Id" } ] } } }, "DeleteSystemOptionFileAttachmentCategoryResourceActionRequest": { "title": "DeleteSystemOptionFileAttachmentCategoryResourceActionRequest", "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 } } }, "BatchGetSystemOptionFileAttachmentCategoryResourceAction": { "title": "BatchGetSystemOptionFileAttachmentCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Reference File Attachment Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Reference File Attachment Category entities", "items": { "$ref": "#/definitions/GetSystemOptionFileAttachmentCategoryResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionFileAttachmentCategoryResourceActionRequest": { "title": "BatchCreateSystemOptionFileAttachmentCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionFileAttachmentCategoryResourceActionRequest" } }, "BatchUpdateSystemOptionFileAttachmentCategoryResourceActionRequest": { "title": "BatchUpdateSystemOptionFileAttachmentCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSystemOptionFileAttachmentCategoryResourceActionRequest" } }, "BatchDeleteSystemOptionFileAttachmentCategoryResourceActionRequest": { "title": "BatchDeleteSystemOptionFileAttachmentCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionFileAttachmentCategoryResourceActionRequest" } }, "GetSystemOptionFileAttachmentFileTypeListResourceActionResponse": { "title": "GetSystemOptionFileAttachmentFileTypeListResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->Version" }, "extension": { "title": "extension", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->Extension" }, "groupId": { "title": "groupId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->GroupId" }, "groupMaxFileSizeInBytes": { "title": "groupMaxFileSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->GroupMaxFileSizeInBytes" }, "groupName": { "title": "groupName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->GroupName" }, "mimeType": { "title": "mimeType", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionFileAttachmentFileType->MimeType" } } }, "GetSystemOptionFileAttachmentFileTypeListResourceAction": { "title": "GetSystemOptionFileAttachmentFileTypeListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option File Attachment File Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option File Attachment File Type entities", "items": { "$ref": "#/definitions/GetSystemOptionFileAttachmentFileTypeListResourceActionResponse" } }, "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" } } }, "GetSystemOptionPageLimitResourceActionResponse": { "title": "GetSystemOptionPageLimitResourceActionResponse", "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": "GetSystemOptionPageLimitResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionPageLimit->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionPageLimit->ModifiedOn" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionPageLimit->EntityType", "x-formatSpecifier": "EntityType" }, "pageLimit": { "title": "pageLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->PageLimit" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ResourceAction" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->SystemOption_Id" } } }, "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" } } }, "GetSystemOptionPageLimitCollectionResourceActionResponse": { "title": "GetSystemOptionPageLimitCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionPageLimitCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionPageLimitCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionPageLimit->EntityType", "x-formatSpecifier": "EntityType" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ResourceAction" }, "pageLimit": { "title": "pageLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->PageLimit" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "EntityType": { "type": "string", "description": "", "x-enumNames": [ "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": [ "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" ] }, "SystemOptionPageLimitResourceActionLookupResourceActionResponse": { "title": "SystemOptionPageLimitResourceActionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SystemOptionPageLimitResourceActionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SystemOptionPageLimitResourceActionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceActionName": { "title": "resourceActionName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceActionName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ModuleName" }, "resourceName": { "title": "resourceName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceName" }, "resourceActionType": { "title": "resourceActionType", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceActionType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateSystemOptionPageLimitResourceActionRequest": { "title": "CreateSystemOptionPageLimitResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionPageLimitResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityType", "pageLimit" ], "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionPageLimit->EntityType", "x-formatSpecifier": "EntityType" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ResourceAction" }, "pageLimit": { "title": "pageLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "SystemOptionPageLimit->PageLimit" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSystemOptionPageLimitResourceActionRequest": { "title": "UpdateSystemOptionPageLimitResourceActionRequest", "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": "resourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionPageLimit->ResourceAction" }, { "title": "pageLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "SystemOptionPageLimit->PageLimit" } ] } } }, "DeleteSystemOptionPageLimitResourceActionRequest": { "title": "DeleteSystemOptionPageLimitResourceActionRequest", "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 } } }, "BatchGetSystemOptionPageLimitResourceAction": { "title": "BatchGetSystemOptionPageLimitResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Page Limit entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Page Limit entities", "items": { "$ref": "#/definitions/GetSystemOptionPageLimitResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionPageLimitRequest": { "title": "BatchCreateSystemOptionPageLimitRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionPageLimitResourceActionRequest" } }, "BatchUpdateSystemOptionPageLimitResourceActionRequest": { "title": "BatchUpdateSystemOptionPageLimitResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSystemOptionPageLimitResourceActionRequest" } }, "BatchDeleteSystemOptionPageLimitResourceActionRequest": { "title": "BatchDeleteSystemOptionPageLimitResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionPageLimitResourceActionRequest" } }, "GetSystemOptionReferenceDataViewPermissionResourceActionResponse": { "title": "GetSystemOptionReferenceDataViewPermissionResourceActionResponse", "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": "GetSystemOptionReferenceDataViewPermissionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReferenceDataViewPermission->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReferenceDataViewPermission->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReferenceDataViewPermission->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionReferenceDataViewPermission->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReferenceDataViewPermission->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReferenceDataViewPermission->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReferenceDataViewPermission->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionReferenceDataViewPermission->ModifiedOn" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->EntityType", "x-formatSpecifier": "EntityType" }, "propertyPath": { "title": "propertyPath", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->PropertyPath" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->SystemOption_Id" } } }, "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" } } }, "GetSystemOptionReferenceDataViewPermissionCollectionResourceActionResponse": { "title": "GetSystemOptionReferenceDataViewPermissionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionReferenceDataViewPermissionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionReferenceDataViewPermissionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->EntityType", "x-formatSpecifier": "EntityType" }, "propertyPath": { "title": "propertyPath", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->PropertyPath" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "SystemOptionReferenceDataViewPermissionPropertyLookupResourceActionResponse": { "title": "SystemOptionReferenceDataViewPermissionPropertyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SystemOptionReferenceDataViewPermissionPropertyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SystemOptionReferenceDataViewPermissionPropertyLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSystemOptionReferenceDataViewPermissionResourceActionRequest": { "title": "CreateSystemOptionReferenceDataViewPermissionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionReferenceDataViewPermissionResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->EntityType", "x-formatSpecifier": "EntityType" }, "propertyPath": { "title": "propertyPath", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->PropertyPath" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSystemOptionReferenceDataViewPermissionResourceActionRequest": { "title": "UpdateSystemOptionReferenceDataViewPermissionResourceActionRequest", "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": "propertyPath", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReferenceDataViewPermission->PropertyPath" } ] } } }, "DeleteSystemOptionReferenceDataViewPermissionResourceActionRequest": { "title": "DeleteSystemOptionReferenceDataViewPermissionResourceActionRequest", "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 } } }, "BatchGetSystemOptionReferenceDataViewPermissionResourceAction": { "title": "BatchGetSystemOptionReferenceDataViewPermissionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Reference Data View Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Reference Data View Permission entities", "items": { "$ref": "#/definitions/GetSystemOptionReferenceDataViewPermissionResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionReferenceDataViewPermissionResourceActionRequest": { "title": "BatchCreateSystemOptionReferenceDataViewPermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, "BatchUpdateSystemOptionReferenceDataViewPermissionResourceActionRequest": { "title": "BatchUpdateSystemOptionReferenceDataViewPermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, "BatchDeleteSystemOptionReferenceDataViewPermissionResourceActionRequest": { "title": "BatchDeleteSystemOptionReferenceDataViewPermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionReferenceDataViewPermissionResourceActionRequest" } }, "GetSystemOptionReportServerEntityResourceActionResponse": { "title": "GetSystemOptionReportServerEntityResourceActionResponse", "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": "GetSystemOptionReportServerEntityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionReportServerEntity->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionReportServerEntity->ModifiedOn" }, "categories": { "title": "categories", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SystemOptionReportServerEntity->Categories", "x-formatSpecifier": "String" }, "defaultReportName": { "title": "defaultReportName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->DefaultReportName" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntity->EntityType", "x-formatSpecifier": "EntityType" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntity->SystemOption_Id" } } }, "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" } } }, "GetSystemOptionReportServerEntityCollectionResourceActionResponse": { "title": "GetSystemOptionReportServerEntityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionReportServerEntityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionReportServerEntityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntity->EntityType", "x-formatSpecifier": "EntityType" }, "defaultReportName": { "title": "defaultReportName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->DefaultReportName" }, "categories": { "title": "categories", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SystemOptionReportServerEntity->Categories", "x-formatSpecifier": "String" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "SystemOptionReportServerEntityCategoryLookupResourceActionResponse": { "title": "SystemOptionReportServerEntityCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SystemOptionReportServerEntityCategoryLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SystemOptionReportServerEntityCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerTag->Name" }, "documentCount": { "title": "documentCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ReportServerTag->DocumentCount" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateSystemOptionReportServerEntityResourceActionRequest": { "title": "CreateSystemOptionReportServerEntityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionReportServerEntityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entityType" ], "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntity->EntityType", "x-formatSpecifier": "EntityType" }, "defaultReportName": { "title": "defaultReportName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->DefaultReportName" }, "categories": { "title": "categories", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SystemOptionReportServerEntity->Categories", "x-formatSpecifier": "String" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSystemOptionReportServerEntityResourceActionRequest": { "title": "UpdateSystemOptionReportServerEntityResourceActionRequest", "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": "categories", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SystemOptionReportServerEntity->Categories", "x-formatSpecifier": "String" }, { "title": "defaultReportName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntity->DefaultReportName" } ] } } }, "DeleteSystemOptionReportServerEntityResourceActionRequest": { "title": "DeleteSystemOptionReportServerEntityResourceActionRequest", "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 } } }, "BatchGetSystemOptionReportServerEntityResourceAction": { "title": "BatchGetSystemOptionReportServerEntityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Report Server Entity entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Report Server Entity entities", "items": { "$ref": "#/definitions/GetSystemOptionReportServerEntityResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionReportServerEntityRequest": { "title": "BatchCreateSystemOptionReportServerEntityRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionReportServerEntityResourceActionRequest" } }, "BatchUpdateSystemOptionReportServerEntityResourceActionRequest": { "title": "BatchUpdateSystemOptionReportServerEntityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSystemOptionReportServerEntityResourceActionRequest" } }, "BatchDeleteSystemOptionReportServerEntityResourceActionRequest": { "title": "BatchDeleteSystemOptionReportServerEntityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionReportServerEntityResourceActionRequest" } }, "GetSystemOptionReportServerEntityDefaultReportResourceActionResponse": { "title": "GetSystemOptionReportServerEntityDefaultReportResourceActionResponse", "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": "GetSystemOptionReportServerEntityDefaultReportResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ModifiedOn" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Expression" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Notes" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ReportName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SequenceNumber" }, "systemOptionReportServerEntityId": { "title": "systemOptionReportServerEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id" }, "systemOptionReportServerEntityEntityType": { "title": "systemOptionReportServerEntityEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_EntityType", "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" } } }, "GetSystemOptionReportServerEntityDefaultReportCollectionForSystemOptionReportServerEntityResourceActionResponse": { "title": "GetSystemOptionReportServerEntityDefaultReportCollectionForSystemOptionReportServerEntityResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionReportServerEntityDefaultReportCollectionForSystemOptionReportServerEntityResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionReportServerEntityDefaultReportCollectionForSystemOptionReportServerEntityResourceActionResponseItemProperties", "type": "object", "properties": { "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ReportName" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Expression" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSystemOptionReportServerEntityDefaultReportCollectionResourceActionResponse": { "title": "GetSystemOptionReportServerEntityDefaultReportCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSystemOptionReportServerEntityDefaultReportCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSystemOptionReportServerEntityDefaultReportCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "systemOptionReportServerEntityId": { "title": "systemOptionReportServerEntityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id" }, "systemOptionReportServerEntityEntityType": { "title": "systemOptionReportServerEntityEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_EntityType", "x-formatSpecifier": "EntityType" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ReportName" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Expression" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->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" } } } }, "SystemOptionReportServerEntityDefaultReportCategoryLookupResourceActionResponse": { "title": "SystemOptionReportServerEntityDefaultReportCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SystemOptionReportServerEntityDefaultReportCategoryLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SystemOptionReportServerEntityDefaultReportCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerTag->Name" }, "documentCount": { "title": "documentCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ReportServerTag->DocumentCount" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateSystemOptionReportServerEntityDefaultReportResourceActionRequest": { "title": "CreateSystemOptionReportServerEntityDefaultReportResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionReportServerEntityDefaultReportResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "systemOptionReportServerEntityId", "reportName", "expression" ], "properties": { "systemOptionReportServerEntityId": { "title": "systemOptionReportServerEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SystemOptionReportServerEntity_Id" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ReportName" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Expression" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest": { "title": "UpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest", "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": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->ReportName" }, { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Expression" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionReportServerEntityDefaultReport->Notes" } ] } } }, "DeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest": { "title": "DeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest", "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 } } }, "BatchGetSystemOptionReportServerEntityDefaultReportResourceAction": { "title": "BatchGetSystemOptionReportServerEntityDefaultReportResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Report Server Entity Default Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Report Server Entity Default Report entities", "items": { "$ref": "#/definitions/GetSystemOptionReportServerEntityDefaultReportResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionReportServerEntityDefaultReportRequest": { "title": "BatchCreateSystemOptionReportServerEntityDefaultReportRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, "BatchUpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest": { "title": "BatchUpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, "BatchDeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest": { "title": "BatchDeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionReportServerEntityDefaultReportResourceActionRequest" } }, "GetSystemOptionWorkOrderStatusResourceActionResponse": { "title": "GetSystemOptionWorkOrderStatusResourceActionResponse", "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": "GetSystemOptionWorkOrderStatusResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedOn" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->SystemOption_Id" }, "validationType": { "title": "validationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatus->ValidationType", "x-formatSpecifier": "SystemOptionWorkOrderStatusType" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatus->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->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" } } }, "GetSystemOptionWorkOrderStatusCollectionResourceActionResponse": { "title": "GetSystemOptionWorkOrderStatusCollectionResourceActionResponse", "type": "object", "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatus->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatus->ModifiedOn" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->Version" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->Id" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->SystemOption_Id" }, "validationType": { "title": "validationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatus->ValidationType", "x-formatSpecifier": "SystemOptionWorkOrderStatusType" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatus->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatus->WorkOrderStatus_Description" } } }, "GetSystemOptionWorkOrderStatusCollectionResourceAction": { "title": "GetSystemOptionWorkOrderStatusCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Work Order Status entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Work Order Status entities", "items": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusCollectionResourceActionResponse" } }, "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" } } }, "CreateSystemOptionWorkOrderStatusResourceActionRequest": { "title": "CreateSystemOptionWorkOrderStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionWorkOrderStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderStatusId", "validationType" ], "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatus->WorkOrderStatus_Id" }, "validationType": { "title": "validationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatus->ValidationType", "x-formatSpecifier": "SystemOptionWorkOrderStatusType" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "DeleteSystemOptionWorkOrderStatusResourceActionRequest": { "title": "DeleteSystemOptionWorkOrderStatusResourceActionRequest", "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 } } }, "BatchGetSystemOptionWorkOrderStatusResourceAction": { "title": "BatchGetSystemOptionWorkOrderStatusResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Work Order Status entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Work Order Status entities", "items": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionWorkOrderStatusResourceActionRequest": { "title": "BatchCreateSystemOptionWorkOrderStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionWorkOrderStatusResourceActionRequest" } }, "BatchDeleteSystemOptionWorkOrderStatusResourceActionRequest": { "title": "BatchDeleteSystemOptionWorkOrderStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionWorkOrderStatusResourceActionRequest" } }, "GetSystemOptionWorkOrderStatusTypeOfWorkResourceActionResponse": { "title": "GetSystemOptionWorkOrderStatusTypeOfWorkResourceActionResponse", "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": "GetSystemOptionWorkOrderStatusTypeOfWorkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedOn" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->SystemOption_Id" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "typeOfWorkWorkType": { "title": "typeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "validationType": { "title": "validationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ValidationType", "x-formatSpecifier": "SystemOptionWorkOrderStatusTypeOfWorkType" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->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" } } }, "GetSystemOptionWorkOrderStatusTypeOfWorkCollectionResourceActionResponse": { "title": "GetSystemOptionWorkOrderStatusTypeOfWorkCollectionResourceActionResponse", "type": "object", "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ModifiedOn" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->Version" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->Id" }, "systemOptionId": { "title": "systemOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->SystemOption_Id" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Description" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "typeOfWorkWorkType": { "title": "typeOfWorkWorkType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_WorkType", "x-formatSpecifier": "WorkType" }, "validationType": { "title": "validationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ValidationType", "x-formatSpecifier": "SystemOptionWorkOrderStatusTypeOfWorkType" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Description" } } }, "GetSystemOptionWorkOrderStatusTypeOfWorkCollectionResourceAction": { "title": "GetSystemOptionWorkOrderStatusTypeOfWorkCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Work Order Status Type Of Work entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Work Order Status Type Of Work entities", "items": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusTypeOfWorkCollectionResourceActionResponse" } }, "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" } } }, "CreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest": { "title": "CreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "workOrderStatusId", "typeOfWorkId", "validationType" ], "properties": { "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->WorkOrderStatus_Id" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->TypeOfWork_Id" }, "validationType": { "title": "validationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SystemOptionWorkOrderStatusTypeOfWork->ValidationType", "x-formatSpecifier": "SystemOptionWorkOrderStatusTypeOfWorkType" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "DeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest": { "title": "DeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest", "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 } } }, "BatchGetSystemOptionWorkOrderStatusTypeOfWorkResourceAction": { "title": "BatchGetSystemOptionWorkOrderStatusTypeOfWorkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of System Option Work Order Status Type Of Work entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of System Option Work Order Status Type Of Work entities", "items": { "$ref": "#/definitions/GetSystemOptionWorkOrderStatusTypeOfWorkResourceActionResponse" } }, "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" } } }, "BatchCreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest": { "title": "BatchCreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest" } }, "BatchDeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest": { "title": "BatchDeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSystemOptionWorkOrderStatusTypeOfWorkResourceActionRequest" } }, "GetUserDefinedFieldResourceActionResponse": { "title": "GetUserDefinedFieldResourceActionResponse", "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": "GetUserDefinedFieldResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserDefinedField->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedField->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedField->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedField->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedField->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedField->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->PermissionTree_Description" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultPredefinedValueId": { "title": "defaultPredefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedField->DefaultPredefinedValue_Id" }, "defaultPredefinedValueDescription": { "title": "defaultPredefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->DefaultPredefinedValue_Description" }, "defaultPredefinedValueValue": { "title": "defaultPredefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedField->DefaultPredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedField->DefaultValue", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedField->Description" }, "enableMatchUpdate": { "title": "enableMatchUpdate", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedField->EnableMatchUpdate" }, "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->Entity", "x-formatSpecifier": "EntityType" }, "fieldType": { "title": "fieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->FieldType", "x-formatSpecifier": "UserDefinedFieldType" }, "isMemo": { "title": "isMemo", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedField->IsMemo" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedField->Name" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedField->SequenceNumber" }, "stringLength": { "title": "stringLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedField->StringLength" } } }, "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" } } }, "GetUserDefinedFieldCollectionResourceActionResponse": { "title": "GetUserDefinedFieldCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetUserDefinedFieldCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetUserDefinedFieldCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->Entity", "x-formatSpecifier": "EntityType" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedField->Name" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedField->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedField->SequenceNumber" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->DataType", "x-formatSpecifier": "DynamicValueType" }, "fieldType": { "title": "fieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->FieldType", "x-formatSpecifier": "UserDefinedFieldType" }, "stringLength": { "title": "stringLength", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedField->StringLength" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "UserDefinedFieldChangePermissionTreeLookupResourceActionResponse": { "title": "UserDefinedFieldChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserDefinedFieldInsertPermissionTreeLookupResourceActionResponse": { "title": "UserDefinedFieldInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserDefinedFieldUserDefinedFieldEntityTypeLookupResourceActionResponse": { "title": "UserDefinedFieldUserDefinedFieldEntityTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldUserDefinedFieldEntityTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldUserDefinedFieldEntityTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserDefinedFieldEntityTypeSummary->EntityType", "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" } } } }, "CreateUserDefinedFieldResourceActionRequest": { "title": "CreateUserDefinedFieldResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserDefinedFieldResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "entity", "name", "description", "permissionTreeId", "dataType", "fieldType" ], "properties": { "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->Entity", "x-formatSpecifier": "EntityType" }, "name": { "title": "name", "type": "string", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z]+[a-zA-Z0-9]*$", "x-nullable": false, "x-propertyPath": "UserDefinedField->Name" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedField->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedField->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedField->SequenceNumber" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->DataType", "x-formatSpecifier": "DynamicValueType" }, "fieldType": { "title": "fieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->FieldType", "x-formatSpecifier": "UserDefinedFieldType" }, "stringLength": { "title": "stringLength", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "UserDefinedField->StringLength" }, "isMemo": { "title": "isMemo", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedField->IsMemo" }, "enableMatchUpdate": { "title": "enableMatchUpdate", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedField->EnableMatchUpdate" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedField->DefaultValue", "x-formatSpecifier": "DynamicValue" }, "defaultPredefinedValueId": { "title": "defaultPredefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedField->DefaultPredefinedValue_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserDefinedFieldResourceActionRequest": { "title": "UpdateUserDefinedFieldResourceActionRequest", "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": "name", "type": "string", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z]+[a-zA-Z0-9]*$", "x-nullable": false, "x-propertyPath": "UserDefinedField->Name" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedField->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedField->SequenceNumber" }, { "title": "isMemo", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedField->IsMemo" }, { "title": "enableMatchUpdate", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedField->EnableMatchUpdate" }, { "title": "defaultValue", "format": "composite", "x-nullable": true, "x-propertyPath": "UserDefinedField->DefaultValue", "x-formatSpecifier": "DynamicValue" }, { "title": "stringLength", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "UserDefinedField->StringLength" }, { "title": "defaultPredefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedField->DefaultPredefinedValue_Id" }, { "title": "fieldType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->FieldType", "x-formatSpecifier": "UserDefinedFieldType" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedField->Notes" } ] } } }, "DeleteUserDefinedFieldResourceActionRequest": { "title": "DeleteUserDefinedFieldResourceActionRequest", "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 } } }, "BatchGetUserDefinedFieldResourceAction": { "title": "BatchGetUserDefinedFieldResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Defined Field entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Defined Field entities", "items": { "$ref": "#/definitions/GetUserDefinedFieldResourceActionResponse" } }, "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" } } }, "BatchCreateUserDefinedFieldRequest": { "title": "BatchCreateUserDefinedFieldRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserDefinedFieldResourceActionRequest" } }, "BatchUpdateUserDefinedFieldResourceActionRequest": { "title": "BatchUpdateUserDefinedFieldResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserDefinedFieldResourceActionRequest" } }, "BatchDeleteUserDefinedFieldResourceActionRequest": { "title": "BatchDeleteUserDefinedFieldResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserDefinedFieldResourceActionRequest" } }, "ChangeUserDefinedFieldIsActiveResourceActionRequest": { "title": "ChangeUserDefinedFieldIsActiveResourceActionRequest", "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": "UserDefinedField->IsActive" } ] } } }, "BatchChangeUserDefinedFieldIsActiveResourceActionRequest": { "title": "BatchChangeUserDefinedFieldIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserDefinedFieldIsActiveResourceActionRequest" } }, "GetUserDefinedFieldPredefinedValueResourceActionResponse": { "title": "GetUserDefinedFieldPredefinedValueResourceActionResponse", "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": "GetUserDefinedFieldPredefinedValueResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedFieldPredefinedValue->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedFieldPredefinedValue->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->SequenceNumber" }, "userDefinedFieldId": { "title": "userDefinedFieldId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Id" }, "userDefinedFieldEntity": { "title": "userDefinedFieldEntity", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Entity", "x-formatSpecifier": "EntityType" }, "userDefinedFieldDescription": { "title": "userDefinedFieldDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Description" }, "userDefinedFieldName": { "title": "userDefinedFieldName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Name" }, "userDefinedFieldDataType": { "title": "userDefinedFieldDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_DataType", "x-formatSpecifier": "DynamicValueType" }, "userDefinedFieldDefaultValue": { "title": "userDefinedFieldDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "userDefinedFieldDefaultPredefinedValueId": { "title": "userDefinedFieldDefaultPredefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Id" }, "userDefinedFieldDefaultPredefinedValueDescription": { "title": "userDefinedFieldDefaultPredefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Description" }, "userDefinedFieldDefaultPredefinedValueValue": { "title": "userDefinedFieldDefaultPredefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_DefaultPredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->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" } } }, "GetUserDefinedFieldPredefinedValueCollectionResourceActionResponse": { "title": "GetUserDefinedFieldPredefinedValueCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetUserDefinedFieldPredefinedValueCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetUserDefinedFieldPredefinedValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userDefinedFieldId": { "title": "userDefinedFieldId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Id" }, "userDefinedFieldEntity": { "title": "userDefinedFieldEntity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Entity", "x-formatSpecifier": "EntityType" }, "userDefinedFieldName": { "title": "userDefinedFieldName", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Name" }, "userDefinedFieldDescription": { "title": "userDefinedFieldDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Description" }, "userDefinedFieldDataType": { "title": "userDefinedFieldDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_DataType", "x-formatSpecifier": "DynamicValueType" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetPredefinedValueForUserDefinedFieldCollectionResourceActionResponse": { "title": "GetPredefinedValueForUserDefinedFieldCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPredefinedValueForUserDefinedFieldCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPredefinedValueForUserDefinedFieldCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->Notes" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->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" } } } }, "UserDefinedFieldPredefinedValueLookupResourceActionResponse": { "title": "UserDefinedFieldPredefinedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldPredefinedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldPredefinedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->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" } } } }, "UserDefinedFieldPredefinedValueChangePermissionTreeLookupResourceActionResponse": { "title": "UserDefinedFieldPredefinedValueChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldPredefinedValueChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldPredefinedValueChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserDefinedFieldPredefinedValueInsertPermissionTreeLookupResourceActionResponse": { "title": "UserDefinedFieldPredefinedValueInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldPredefinedValueInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldPredefinedValueInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserDefinedFieldPredefinedValueUserDefinedFieldLookupResourceActionResponse": { "title": "UserDefinedFieldPredefinedValueUserDefinedFieldLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedFieldPredefinedValueUserDefinedFieldLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedFieldPredefinedValueUserDefinedFieldLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedField->Name" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedField->Description" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->DataType", "x-formatSpecifier": "DynamicValueType" }, "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedField->Entity", "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" } } } }, "CreateUserDefinedFieldPredefinedValueResourceActionRequest": { "title": "CreateUserDefinedFieldPredefinedValueResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserDefinedFieldPredefinedValueResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userDefinedFieldId", "value", "description", "isActive" ], "properties": { "userDefinedFieldId": { "title": "userDefinedFieldId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->UserDefinedField_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserDefinedFieldPredefinedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserDefinedFieldPredefinedValueResourceActionRequest": { "title": "UpdateUserDefinedFieldPredefinedValueResourceActionRequest", "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": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedFieldPredefinedValue->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedFieldPredefinedValue->Notes" } ] } } }, "DeleteUserDefinedFieldPredefinedValueResourceActionRequest": { "title": "DeleteUserDefinedFieldPredefinedValueResourceActionRequest", "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 } } }, "BatchGetUserDefinedFieldPredefinedValueResourceAction": { "title": "BatchGetUserDefinedFieldPredefinedValueResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Defined Field Predefined Value entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Defined Field Predefined Value entities", "items": { "$ref": "#/definitions/GetUserDefinedFieldPredefinedValueResourceActionResponse" } }, "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" } } }, "BatchCreateUserDefinedFieldPredefinedValueRequest": { "title": "BatchCreateUserDefinedFieldPredefinedValueRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserDefinedFieldPredefinedValueResourceActionRequest" } }, "BatchUpdateUserDefinedFieldPredefinedValueResourceActionRequest": { "title": "BatchUpdateUserDefinedFieldPredefinedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserDefinedFieldPredefinedValueResourceActionRequest" } }, "BatchDeleteUserDefinedFieldPredefinedValueResourceActionRequest": { "title": "BatchDeleteUserDefinedFieldPredefinedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserDefinedFieldPredefinedValueResourceActionRequest" } }, "ChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest": { "title": "ChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest", "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": "UserDefinedFieldPredefinedValue->IsActive" } ] } } }, "BatchChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest": { "title": "BatchChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserDefinedFieldPredefinedValueIsActiveResourceActionRequest" } } }, "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": "Background Task" }, { "name": "Background Task Step" }, { "name": "Change Log" }, { "name": "Delayed Side Effects" }, { "name": "Entities" }, { "name": "Entity Exists Check" }, { "name": "Health" }, { "name": "Import" }, { "name": "Import File" }, { "name": "Import Schema" }, { "name": "Licence" }, { "name": "Notification Event Attachment Outbox" }, { "name": "Notification Event Outbox" }, { "name": "Notification Outbox" }, { "name": "Notification Outbox Log" }, { "name": "Scheduled Background Task" }, { "name": "Scheduled Job" }, { "name": "System Logs" }, { "name": "System Option" }, { "name": "System Option Default Standard Task" }, { "name": "System Option Reference File Attachment Category" }, { "name": "System Option File Attachment File Type" }, { "name": "System Option Page Limit" }, { "name": "System Option Reference Data View Permission" }, { "name": "System Option Report Server Entity" }, { "name": "System Option Report Server Entity Default Report" }, { "name": "System Option Work Order Status" }, { "name": "System Option Work Order Status Type Of Work" }, { "name": "User Defined Field" }, { "name": "User Defined Field Predefined Value" } ], "x-tagGroups": [ { "name": "SYSTEM", "tags": [ "Background Task", "Background Task Step", "Change Log", "Delayed Side Effects", "Entities", "Entity Exists Check", "Health", "Import", "Import File", "Import Schema", "Licence", "Notification Event Attachment Outbox", "Notification Event Outbox", "Notification Outbox", "Notification Outbox Log", "Scheduled Background Task", "Scheduled Job", "System Logs", "System Option", "System Option Default Standard Task", "System Option Reference File Attachment Category", "System Option File Attachment File Type", "System Option Page Limit", "System Option Reference Data View Permission", "System Option Report Server Entity", "System Option Report Server Entity Default Report", "System Option Work Order Status", "System Option Work Order Status Type Of Work", "User Defined Field", "User Defined Field Predefined Value" ] } ] }