{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key AMPC Shared API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "host": ":443", "basePath": "/api/tenants/{client}/{connection}", "schemes": [ "https" ], "consumes": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json" ], "paths": { "/Modules/AMPC/AssetWarranties/{id}": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a Asset Warranty resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AssetWarranty->Code | string | |\r\n| isActive | AssetWarranty->IsActive | boolean | |\r\n| createdByUserId | AssetWarranty->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetWarranty->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetWarranty->CreatedByUser_FullName | string | |\r\n| createdOn | AssetWarranty->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetWarranty->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetWarranty->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetWarranty->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetWarranty->ModifiedOn | string | date-time |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| permissionTreeId | AssetWarranty->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetWarranty->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetWarranty->PermissionTree_Description | string | |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| assetId | AssetWarranty->Asset_Id | integer | int64 |\r\n| assetCode | AssetWarranty->Asset_Code | string | |\r\n| assetDescription | AssetWarranty->Asset_Description | string | |\r\n| assetRecordType | AssetWarranty->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentId | AssetWarranty->Component_Id | integer | int64 |\r\n| componentCode | AssetWarranty->Component_Code | string | |\r\n| componentDescription | AssetWarranty->Component_Description | string | |\r\n| componentRecordType | AssetWarranty->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | AssetWarranty->Description | string | |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| linkedToEntityType | AssetWarranty->LinkedToEntityType | 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| notes | AssetWarranty->Notes | string | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| supplierDescription | AssetWarranty->Supplier_Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n| warrantyTypeDescription | AssetWarranty->WarrantyType_Description | string | |\r\n", "operationId": "GetAssetWarranty", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Warranty Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Warranty", "schema": { "$ref": "#/definitions/GetAssetWarrantyResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Warranty" ], "summary": "Update an existing Asset Warranty resource.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| notes | AssetWarranty->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| warrantyExpiryDate | Nullable | False | |\r\n| warrantyTypeId | Nullable | False | |\r\n| strict | Nullable | False | |\r\n\r\n", "operationId": "UpdateAssetWarranty", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Warranty Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetWarrantyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Warranty 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": [ "Asset Warranty" ], "summary": "Delete an existing Asset Warranty resource.", "description": "### Request Body\r\n#### 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 | AssetWarranty->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": "DeleteAssetWarranty", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Warranty Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAssetWarrantyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Warranty 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/AMPC/AssetWarranties": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranty resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| assetId | AssetWarranty->Asset_Id | integer | int64 |\r\n| assetTreePathItems | AssetWarranty->Asset_TreePathItems | array | array |\r\n| assetCode | AssetWarranty->Asset_Code | string | |\r\n| componentId | AssetWarranty->Component_Id | integer | int64 |\r\n| componentTreePathItems | AssetWarranty->Component_TreePathItems | array | array |\r\n| componentCode | AssetWarranty->Component_Code | string | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| linkedToEntityType | AssetWarranty->LinkedToEntityType | 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": "GetAssetWarrantyCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Warranty collection", "schema": { "$ref": "#/definitions/GetAssetWarrantyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Warranty" ], "summary": "Create a new Asset Warranty resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetId | AssetWarranty->Asset_Id | integer | int64 |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| permissionTreeId | AssetWarranty->PermissionTree_Id | integer | int64 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| componentId | AssetWarranty->Component_Id | integer | int64 |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| notes | AssetWarranty->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| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| warrantyTypeId | Required | True | |\r\n| warrantyTypeId | Nullable | False | |\r\n| warrantyExpiryDate | Required | True | |\r\n| warrantyExpiryDate | Nullable | False | |\r\n| strict | Required | True | |\r\n| strict | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| supplierId | System Generated | true | If no value specified |\r\n\r\n", "operationId": "CreateAssetWarranty", "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/CreateAssetWarrantyResourceActionRequest" } }, { "$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/AMPC/InPlaceAssets/{id}/Warranties": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranty resources for the InPlaceAsset", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n", "operationId": "GetAssetWarrantyForInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Warranty collection", "schema": { "$ref": "#/definitions/GetAssetWarrantyForInPlaceAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/{id}/Warranties": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranty resources for the PlaceholderAsset", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n", "operationId": "GetAssetWarrantyForPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Warranty collection", "schema": { "$ref": "#/definitions/GetAssetWarrantyForPlaceholderAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/Warranties": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranty resources for the PlaceholderAssetComponent", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n", "operationId": "GetAssetWarrantyForPlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Component 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 Asset Warranty collection", "schema": { "$ref": "#/definitions/GetAssetWarrantyForPlaceholderAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/Warranties": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranty resources for the RegularAsset", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n", "operationId": "GetAssetWarrantyForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Warranty collection", "schema": { "$ref": "#/definitions/GetAssetWarrantyForRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/{id}/Warranties": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranties resources for the RegularAssetComponent", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n", "operationId": "GetAssetWarrantyForRegularAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Component 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 Asset Warranty collection", "schema": { "$ref": "#/definitions/GetAssetWarrantiesForRegularAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Lookups/LookupAssetWarrantyAsset": { "get": { "tags": [ "Asset Warranty" ], "summary": "Lookup the Asset for the Asset Warranty.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetWarrantyAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/AssetWarrantyAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Lookups/LookupAssetWarrantyChangePermissionTree": { "get": { "tags": [ "Asset Warranty" ], "summary": "Lookup the permission set for changing the Asset Warranty.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetWarrantyChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetWarrantyChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Lookups/LookupAssetWarrantyComponent": { "get": { "tags": [ "Asset Warranty" ], "summary": "Lookup the Asset Component for the Asset Warranty.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| recordType | AssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetWarrantyComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/AssetWarrantyComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Lookups/LookupAssetWarrantyInsertPermissionTree": { "get": { "tags": [ "Asset Warranty" ], "summary": "Lookup the permission set for creating the Asset Warranty.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetWarrantyInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetWarrantyInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Lookups/LookupAssetWarrantySupplier": { "get": { "tags": [ "Asset Warranty" ], "summary": "Lookup the Asset Warranty for the Asset Warranty.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupAssetWarrantySupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Supplier collection", "schema": { "$ref": "#/definitions/AssetWarrantiesSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Lookups/LookupAssetWarrantyWarrantyType": { "get": { "tags": [ "Asset Warranty" ], "summary": "Lookup the Asset Warranty for the Asset Warranty.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| code | WarrantyType->Code | string | |\r\n| description | WarrantyType->Description | string | |\r\n", "operationId": "LookupAssetWarrantyWarrantyType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Warranty Type collection", "schema": { "$ref": "#/definitions/AssetWarrantiesWarrantyTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Batch/{ids}": { "get": { "tags": [ "Asset Warranty" ], "summary": "Get a collection of Asset Warranty resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AssetWarranty->Code | string | |\r\n| isActive | AssetWarranty->IsActive | boolean | |\r\n| createdByUserId | AssetWarranty->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetWarranty->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetWarranty->CreatedByUser_FullName | string | |\r\n| createdOn | AssetWarranty->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetWarranty->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetWarranty->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetWarranty->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetWarranty->ModifiedOn | string | date-time |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| permissionTreeId | AssetWarranty->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetWarranty->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetWarranty->PermissionTree_Description | string | |\r\n| id | AssetWarranty->Id | integer | int64 |\r\n| assetId | AssetWarranty->Asset_Id | integer | int64 |\r\n| assetCode | AssetWarranty->Asset_Code | string | |\r\n| assetDescription | AssetWarranty->Asset_Description | string | |\r\n| assetRecordType | AssetWarranty->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentId | AssetWarranty->Component_Id | integer | int64 |\r\n| componentCode | AssetWarranty->Component_Code | string | |\r\n| componentDescription | AssetWarranty->Component_Description | string | |\r\n| componentRecordType | AssetWarranty->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | AssetWarranty->Description | string | |\r\n| expired | AssetWarranty->Expired | boolean | |\r\n| linkedToEntityType | AssetWarranty->LinkedToEntityType | 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| notes | AssetWarranty->Notes | string | |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetWarranty->Supplier_Code | string | |\r\n| supplierDescription | AssetWarranty->Supplier_Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyTypeCode | AssetWarranty->WarrantyType_Code | string | |\r\n| warrantyTypeDescription | AssetWarranty->WarrantyType_Description | string | |\r\n", "operationId": "BatchGetAssetWarranty", "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 Asset Warranty id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Warranty collection", "schema": { "$ref": "#/definitions/BatchGetAssetWarrantyResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetWarranties/Batch": { "post": { "tags": [ "Asset Warranty" ], "summary": "Create a new collection of Asset Warranty resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetId | AssetWarranty->Asset_Id | integer | int64 |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| permissionTreeId | AssetWarranty->PermissionTree_Id | integer | int64 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| componentId | AssetWarranty->Component_Id | integer | int64 |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| notes | AssetWarranty->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| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| warrantyTypeId | Required | True | |\r\n| warrantyTypeId | Nullable | False | |\r\n| warrantyExpiryDate | Required | True | |\r\n| warrantyExpiryDate | Nullable | False | |\r\n| strict | Required | True | |\r\n| strict | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| supplierId | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchCreateAssetWarranty", "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/BatchCreateAssetWarrantyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Asset Warranty 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": [ "Asset Warranty" ], "summary": "Update a collection of existing Asset Warranty resources.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| code | AssetWarranty->Code | string | |\r\n| description | AssetWarranty->Description | string | |\r\n| warrantyExpiryDate | AssetWarranty->WarrantyExpiryDate | string | date |\r\n| warrantyTypeId | AssetWarranty->WarrantyType_Id | integer | int64 |\r\n| strict | AssetWarranty->Strict | boolean | |\r\n| supplierId | AssetWarranty->Supplier_Id | integer | int64 |\r\n| notes | AssetWarranty->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| warrantyExpiryDate | Nullable | False | |\r\n| warrantyTypeId | Nullable | False | |\r\n| strict | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAssetWarranty", "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/BatchUpdateAssetWarrantyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Warranty 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": [ "Asset Warranty" ], "summary": "Delete a collection of existing Asset Warranty resources.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->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": "BatchDeleteAssetWarranty", "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/BatchDeleteAssetWarrantyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Warranty 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/AMPC/AssetWarranties/{id}/Active": { "patch": { "tags": [ "Asset Warranty" ], "summary": "Change the IsActive status for an existing Asset Warranty resource.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Version | integer | int32 |\r\n| isActive | AssetWarranty->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": "ChangeAssetWarrantyIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Warranty Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetWarrantyIsActiveResourceActionRequest" } }, { "$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/AMPC/AssetWarranties/{id}/PermissionTree": { "patch": { "tags": [ "Asset Warranty" ], "summary": "Change the PermissionTree for an existing Asset Warranty resource.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Version | integer | int32 |\r\n| permissionTreeId | AssetWarranty->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeAssetWarrantyPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Warranty Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetWarrantyPermissionTreeResourceActionRequest" } }, { "$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/AMPC/AssetWarranties/Batch/Active": { "patch": { "tags": [ "Asset Warranty" ], "summary": "Change the IsActive status for a collection of existing Asset Warranty resources.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| isActive | AssetWarranty->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": "BatchChangeAssetWarrantyIsActive", "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/BatchChangeAssetWarrantyIsActiveResourceActionRequest" } }, { "$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/AMPC/AssetWarranties/Batch/PermissionTree": { "patch": { "tags": [ "Asset Warranty" ], "summary": "Change the PermissionTree status for a collection of existing Asset Warranty resources.", "description": "### Request Body\r\n#### 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 | AssetWarranty->Id | integer | int64 |\r\n| version | AssetWarranty->Version | integer | int32 |\r\n| permissionTreeId | AssetWarranty->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAssetWarrantyPermissionTree", "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/BatchChangeAssetWarrantyPermissionTreeResourceActionRequest" } }, { "$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/AMPC/Conditions/{id}": { "get": { "tags": [ "Condition" ], "summary": "Get a Condition resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Condition->Code | string | |\r\n| isActive | Condition->IsActive | boolean | |\r\n| createdByUserId | Condition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Condition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Condition->CreatedByUser_FullName | string | |\r\n| createdOn | Condition->CreatedOn | string | date-time |\r\n| modifiedByUserId | Condition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Condition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Condition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Condition->ModifiedOn | string | date-time |\r\n| version | Condition->Version | integer | int32 |\r\n| permissionTreeId | Condition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Condition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Condition->PermissionTree_Description | string | |\r\n| id | Condition->Id | integer | int64 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n| description | Condition->Description | string | |\r\n| notes | Condition->Notes | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Condition", "schema": { "$ref": "#/definitions/GetConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Condition" ], "summary": "Update an existing Condition resource.", "description": "### Request Body\r\n#### 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 | Condition->Version | integer | int32 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | Condition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "UpdateCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTypeConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "applyToTypeTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Task conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Condition descendants (default=True)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeTaskConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Task Condition descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition 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": [ "Condition" ], "summary": "Delete an existing Condition resource.", "description": "### Request Body\r\n#### 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 | Condition->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": "DeleteCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition 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/AMPC/Conditions": { "get": { "tags": [ "Condition" ], "summary": "Get a collection of Condition 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 | Condition->Id | integer | int64 |\r\n| version | Condition->Version | integer | int32 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | Condition->Notes | string | |\r\n| createdOn | Condition->CreatedOn | string | date-time |\r\n| modifiedOn | Condition->ModifiedOn | string | date-time |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "GetConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Condition collection", "schema": { "$ref": "#/definitions/GetConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Condition" ], "summary": "Create a new Condition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Condition->PermissionTree_Id | integer | int64 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | Condition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| conditionTypeId | Required | True | |\r\n| conditionTypeId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "CreateCondition", "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/CreateConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTypeConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "applyToTypeTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Task conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Condition descendants (default=True)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeTaskConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Task Condition descendants (default=True)", "x-nullable": true }, { "$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/AMPC/ConditionTypes/{id}/conditions": { "get": { "tags": [ "Condition" ], "summary": "Get a collection of Condition resources for the Condition Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Condition->Id | integer | int64 |\r\n| version | Condition->Version | integer | int32 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetConditionForConditionTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Type 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 Condition collection", "schema": { "$ref": "#/definitions/GetConditionForConditionTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Conditions/Lookups/LookupConditionChangePermissionTree": { "get": { "tags": [ "Condition" ], "summary": "Lookup the permission set for changing the Condition.", "description": "### Response Body\r\n#### Payload\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": "LookupConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/ConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Conditions/Lookups/LookupConditionConditionType": { "get": { "tags": [ "Condition" ], "summary": "Lookup the Condition Type for the Condition.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ConditionType->Id | integer | int64 |\r\n| code | ConditionType->Code | string | |\r\n| description | ConditionType->Description | string | |\r\n", "operationId": "LookupConditionConditionType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Condition Type collection", "schema": { "$ref": "#/definitions/ConditionConditionTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Conditions/Lookups/LookupConditionInsertPermissionTree": { "get": { "tags": [ "Condition" ], "summary": "Lookup the permission set for creating the Condition.", "description": "### Response Body\r\n#### Payload\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": "LookupConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/ConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Conditions/Batch/{ids}": { "get": { "tags": [ "Condition" ], "summary": "Get a collection of Condition resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Condition->Code | string | |\r\n| isActive | Condition->IsActive | boolean | |\r\n| createdByUserId | Condition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Condition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Condition->CreatedByUser_FullName | string | |\r\n| createdOn | Condition->CreatedOn | string | date-time |\r\n| modifiedByUserId | Condition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Condition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Condition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Condition->ModifiedOn | string | date-time |\r\n| version | Condition->Version | integer | int32 |\r\n| permissionTreeId | Condition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Condition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Condition->PermissionTree_Description | string | |\r\n| id | Condition->Id | integer | int64 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n| description | Condition->Description | string | |\r\n| notes | Condition->Notes | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetCondition", "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 Condition 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 Condition collection", "schema": { "$ref": "#/definitions/BatchGetConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Conditions/Batch": { "post": { "tags": [ "Condition" ], "summary": "Create a new collection of Condition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Condition->PermissionTree_Id | integer | int64 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | Condition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| conditionTypeId | Required | True | |\r\n| conditionTypeId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCondition", "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/BatchCreateConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTypeConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "applyToTypeTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Task conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Condition descendants (default=True)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeTaskConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Task Condition descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Condition 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": [ "Condition" ], "summary": "Update a collection of existing Condition resources.", "description": "### Request Body\r\n#### 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 | Condition->Id | integer | int64 |\r\n| version | Condition->Version | integer | int32 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| sequenceNumber | Condition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | Condition->AdjustmentFactor | number | decimal |\r\n| state | Condition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | Condition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCondition", "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/BatchUpdateConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTypeConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "applyToTypeTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Type Task conditions (default=False)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Condition descendants (default=True)", "x-nullable": true }, { "type": "boolean", "name": "inheritToTypeTaskConditionDescendants", "in": "query", "description": "Inherit the changes to all the Regular Asset Type Task Condition descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition 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": [ "Condition" ], "summary": "Delete a collection of existing Condition resources.", "description": "### Request Body\r\n#### 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 | Condition->Id | integer | int64 |\r\n| version | Condition->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": "BatchDeleteCondition", "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/BatchDeleteConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition 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/AMPC/Conditions/{id}/Active": { "patch": { "tags": [ "Condition" ], "summary": "Change the IsActive status for an existing Condition resource.", "description": "### Request Body\r\n#### 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 | Condition->Version | integer | int32 |\r\n| isActive | Condition->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": "ChangeConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeConditionIsActiveResourceActionRequest" } }, { "$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/AMPC/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Condition" ], "summary": "Change the PermissionTree for an existing Condition resource.", "description": "### Request Body\r\n#### 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 | Condition->Version | integer | int32 |\r\n| permissionTreeId | Condition->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeConditionPermissionTreeResourceActionRequest" } }, { "$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/AMPC/Conditions/Batch/Active": { "patch": { "tags": [ "Condition" ], "summary": "Change the IsActive status for a collection of existing Condition resources.", "description": "### Request Body\r\n#### 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 | Condition->Id | integer | int64 |\r\n| version | Condition->Version | integer | int32 |\r\n| isActive | Condition->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": "BatchChangeConditionIsActive", "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/BatchChangeConditionIsActiveResourceActionRequest" } }, { "$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/AMPC/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Condition" ], "summary": "Change the PermissionTree status for a collection of existing Condition resources.", "description": "### Request Body\r\n#### 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 | Condition->Id | integer | int64 |\r\n| version | Condition->Version | integer | int32 |\r\n| permissionTreeId | Condition->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeConditionPermissionTree", "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/BatchChangeConditionPermissionTreeResourceActionRequest" } }, { "$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/AMPC/ConditionTypes/{id}": { "get": { "tags": [ "Condition Type" ], "summary": "Get a Condition Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | ConditionType->Code | string | |\r\n| createdByUserId | ConditionType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ConditionType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ConditionType->CreatedByUser_FullName | string | |\r\n| createdOn | ConditionType->CreatedOn | string | date-time |\r\n| isActive | ConditionType->IsActive | boolean | |\r\n| modifiedByUserId | ConditionType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ConditionType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ConditionType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ConditionType->ModifiedOn | string | date-time |\r\n| permissionTreeId | ConditionType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ConditionType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ConditionType->PermissionTree_Description | string | |\r\n| version | ConditionType->Version | integer | int32 |\r\n| id | ConditionType->Id | integer | int64 |\r\n| description | ConditionType->Description | string | |\r\n| notes | ConditionType->Notes | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetConditionType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Condition Type", "schema": { "$ref": "#/definitions/GetConditionTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Condition Type" ], "summary": "Update an existing Condition Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ConditionType->Version | integer | int32 |\r\n| code | ConditionType->Code | string | |\r\n| description | ConditionType->Description | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n| notes | ConditionType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateConditionType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateConditionTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Condition Type" ], "summary": "Delete an existing Condition Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ConditionType->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": "DeleteConditionType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteConditionTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/ConditionTypes": { "get": { "tags": [ "Condition Type" ], "summary": "Get a collection of Condition Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ConditionType->Id | integer | int64 |\r\n| version | ConditionType->Version | integer | int32 |\r\n| code | ConditionType->Code | string | |\r\n| description | ConditionType->Description | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n| notes | ConditionType->Notes | string | |\r\n| createdOn | ConditionType->CreatedOn | string | date-time |\r\n| modifiedOn | ConditionType->ModifiedOn | string | date-time |\r\n", "operationId": "GetConditionTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Condition Type collection", "schema": { "$ref": "#/definitions/GetConditionTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Condition Type" ], "summary": "Create a new Condition Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | ConditionType->PermissionTree_Id | integer | int64 |\r\n| code | ConditionType->Code | string | |\r\n| description | ConditionType->Description | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n| notes | ConditionType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateConditionType", "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/CreateConditionTypeResourceActionRequest" } }, { "$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/AMPC/ConditionTypes/Lookups/LookupConditionTypeChangePermissionTree": { "get": { "tags": [ "Condition Type" ], "summary": "Lookup the permission set for changing the Condition Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupConditionTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/ConditionTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/ConditionTypes/Lookups/LookupConditionTypeInsertPermissionTree": { "get": { "tags": [ "Condition Type" ], "summary": "Lookup the permission set for creating the Condition Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupConditionTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/ConditionTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/ConditionTypes/Batch/{ids}": { "get": { "tags": [ "Condition Type" ], "summary": "Get a collection of Condition Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | ConditionType->Code | string | |\r\n| createdByUserId | ConditionType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ConditionType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ConditionType->CreatedByUser_FullName | string | |\r\n| createdOn | ConditionType->CreatedOn | string | date-time |\r\n| isActive | ConditionType->IsActive | boolean | |\r\n| modifiedByUserId | ConditionType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ConditionType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ConditionType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ConditionType->ModifiedOn | string | date-time |\r\n| permissionTreeId | ConditionType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ConditionType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ConditionType->PermissionTree_Description | string | |\r\n| version | ConditionType->Version | integer | int32 |\r\n| id | ConditionType->Id | integer | int64 |\r\n| description | ConditionType->Description | string | |\r\n| notes | ConditionType->Notes | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetConditionType", "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 Condition Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Condition Type collection", "schema": { "$ref": "#/definitions/BatchGetConditionTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/ConditionTypes/Batch": { "post": { "tags": [ "Condition Type" ], "summary": "Create a new collection of Condition Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | ConditionType->PermissionTree_Id | integer | int64 |\r\n| code | ConditionType->Code | string | |\r\n| description | ConditionType->Description | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n| notes | ConditionType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateConditionType", "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/BatchCreateConditionTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Condition Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Condition Type" ], "summary": "Update a collection of existing Condition Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ConditionType->Id | integer | int64 |\r\n| version | ConditionType->Version | integer | int32 |\r\n| code | ConditionType->Code | string | |\r\n| description | ConditionType->Description | string | |\r\n| sequenceNumber | ConditionType->SequenceNumber | integer | int32 |\r\n| notes | ConditionType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateConditionType", "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/BatchUpdateConditionTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Condition Type" ], "summary": "Delete a collection of existing Condition Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ConditionType->Id | integer | int64 |\r\n| version | ConditionType->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": "BatchDeleteConditionType", "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/BatchDeleteConditionTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Condition Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/ConditionTypes/{id}/Active": { "patch": { "tags": [ "Condition Type" ], "summary": "Change the IsActive status for an existing Condition Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ConditionType->Version | integer | int32 |\r\n| isActive | ConditionType->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": "ChangeConditionTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeConditionTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/ConditionTypes/{id}/PermissionTree": { "patch": { "tags": [ "Condition Type" ], "summary": "Change the PermissionTree for an existing Condition Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ConditionType->Version | integer | int32 |\r\n| permissionTreeId | ConditionType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeConditionTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Condition Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeConditionTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/ConditionTypes/Batch/Active": { "patch": { "tags": [ "Condition Type" ], "summary": "Change the IsActive status for a collection of existing Condition Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ConditionType->Id | integer | int64 |\r\n| version | ConditionType->Version | integer | int32 |\r\n| isActive | ConditionType->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": "BatchChangeConditionTypeIsActive", "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/BatchChangeConditionTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/ConditionTypes/Batch/PermissionTree": { "patch": { "tags": [ "Condition Type" ], "summary": "Change the PermissionTree status for a collection of existing Condition Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ConditionType->Id | integer | int64 |\r\n| version | ConditionType->Version | integer | int32 |\r\n| permissionTreeId | ConditionType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeConditionTypePermissionTree", "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/BatchChangeConditionTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/Events/{id}": { "get": { "tags": [ "Event" ], "summary": "Get a Event resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Event->Code | string | |\r\n| createdByUserId | Event->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Event->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Event->CreatedByUser_FullName | string | |\r\n| createdOn | Event->CreatedOn | string | date-time |\r\n| isActive | Event->IsActive | boolean | |\r\n| modifiedByUserId | Event->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Event->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Event->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Event->ModifiedOn | string | date-time |\r\n| permissionTreeId | Event->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Event->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Event->PermissionTree_Description | string | |\r\n| version | Event->Version | integer | int32 |\r\n| id | Event->Id | integer | int64 |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| description | Event->Description | string | |\r\n| eventDate | Event->EventDate | string | date |\r\n| notes | Event->Notes | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n", "operationId": "GetEvent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Event Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Event", "schema": { "$ref": "#/definitions/GetEventResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Event" ], "summary": "Update an existing Event resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Event->Version | integer | int32 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n| eventDate | Event->EventDate | string | date |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| notes | Event->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| eventDate | Nullable | False | |\r\n| adjustWorkOrders | Nullable | False | |\r\n\r\n", "operationId": "UpdateEvent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Event was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Event" ], "summary": "Delete an existing Event resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Event->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": "DeleteEvent", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Event Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Event was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Events": { "get": { "tags": [ "Event" ], "summary": "Get a collection of Event resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Event->Id | integer | int64 |\r\n| version | Event->Version | integer | int32 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n| eventDate | Event->EventDate | string | date |\r\n| permissionTreeCode | Event->PermissionTree_Code | string | |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| notes | Event->Notes | string | |\r\n| createdOn | Event->CreatedOn | string | date-time |\r\n| modifiedOn | Event->ModifiedOn | string | date-time |\r\n", "operationId": "GetEventCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Event collection", "schema": { "$ref": "#/definitions/GetEventCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Event" ], "summary": "Create a new Event resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Event->PermissionTree_Id | integer | int64 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n| eventDate | Event->EventDate | string | date |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| notes | Event->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| eventDate | Required | True | |\r\n| eventDate | Nullable | False | |\r\n| adjustWorkOrders | Required | True | |\r\n| adjustWorkOrders | Nullable | False | |\r\n\r\n", "operationId": "CreateEvent", "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/CreateEventResourceActionRequest" } }, { "$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/AMPC/Events/Lookups/LookupEventChangePermissionTree": { "get": { "tags": [ "Event" ], "summary": "Lookup the permission set for changing the Event.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupEventChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/EventChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Events/Lookups/LookupEventInsertPermissionTree": { "get": { "tags": [ "Event" ], "summary": "Lookup the permission set for creating the Event.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupEventInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/EventInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Events/Batch/{ids}": { "get": { "tags": [ "Event" ], "summary": "Get a collection of Event resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Event->Code | string | |\r\n| createdByUserId | Event->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Event->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Event->CreatedByUser_FullName | string | |\r\n| createdOn | Event->CreatedOn | string | date-time |\r\n| isActive | Event->IsActive | boolean | |\r\n| modifiedByUserId | Event->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Event->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Event->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Event->ModifiedOn | string | date-time |\r\n| permissionTreeId | Event->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Event->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Event->PermissionTree_Description | string | |\r\n| version | Event->Version | integer | int32 |\r\n| id | Event->Id | integer | int64 |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| description | Event->Description | string | |\r\n| eventDate | Event->EventDate | string | date |\r\n| notes | Event->Notes | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetEvent", "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 Event id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Event collection", "schema": { "$ref": "#/definitions/BatchGetEventResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Events/Batch": { "post": { "tags": [ "Event" ], "summary": "Create a new collection of Event resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Event->PermissionTree_Id | integer | int64 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n| eventDate | Event->EventDate | string | date |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| notes | Event->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| eventDate | Required | True | |\r\n| eventDate | Nullable | False | |\r\n| adjustWorkOrders | Required | True | |\r\n| adjustWorkOrders | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateEvent", "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/BatchCreateEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Event batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Event" ], "summary": "Update a collection of existing Event resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Event->Id | integer | int64 |\r\n| version | Event->Version | integer | int32 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n| sequenceNumber | Event->SequenceNumber | integer | int32 |\r\n| adjustWorkOrders | Event->AdjustWorkOrders | boolean | |\r\n| eventDate | Event->EventDate | string | date |\r\n| notes | Event->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| adjustWorkOrders | Nullable | False | |\r\n| eventDate | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateEvent", "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/BatchUpdateEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Event batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Event" ], "summary": "Delete a collection of existing Event resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Event->Id | integer | int64 |\r\n| version | Event->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": "BatchDeleteEvent", "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/BatchDeleteEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Event batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Events/{id}/Active": { "patch": { "tags": [ "Event" ], "summary": "Change the IsActive status for an existing Event resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Event->Version | integer | int32 |\r\n| isActive | Event->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": "ChangeEventIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeEventIsActiveResourceActionRequest" } }, { "$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/AMPC/Events/{id}/PermissionTree": { "patch": { "tags": [ "Event" ], "summary": "Change the PermissionTree for an existing Event resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Event->Version | integer | int32 |\r\n| permissionTreeId | Event->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeEventPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeEventPermissionTreeResourceActionRequest" } }, { "$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/AMPC/Events/Batch/Active": { "patch": { "tags": [ "Event" ], "summary": "Change the IsActive status for a collection of existing Event resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Event->Id | integer | int64 |\r\n| version | Event->Version | integer | int32 |\r\n| isActive | Event->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": "BatchChangeEventIsActive", "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/BatchChangeEventIsActiveResourceActionRequest" } }, { "$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/AMPC/Events/Batch/PermissionTree": { "patch": { "tags": [ "Event" ], "summary": "Change the PermissionTree status for a collection of existing Event resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Event->Id | integer | int64 |\r\n| version | Event->Version | integer | int32 |\r\n| permissionTreeId | Event->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeEventPermissionTree", "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/BatchChangeEventPermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureCauses/{id}": { "get": { "tags": [ "Failure Cause" ], "summary": "Get a Failure Cause resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FailureCause->Code | string | |\r\n| isActive | FailureCause->IsActive | boolean | |\r\n| createdByUserId | FailureCause->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureCause->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureCause->CreatedByUser_FullName | string | |\r\n| createdOn | FailureCause->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureCause->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureCause->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureCause->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureCause->ModifiedOn | string | date-time |\r\n| version | FailureCause->Version | integer | int32 |\r\n| permissionTreeId | FailureCause->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureCause->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureCause->PermissionTree_Description | string | |\r\n| id | FailureCause->Id | integer | int64 |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n| description | FailureCause->Description | string | |\r\n| notes | FailureCause->Notes | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n", "operationId": "GetFailureCause", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Cause", "schema": { "$ref": "#/definitions/GetFailureCauseResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Cause" ], "summary": "Update an existing Failure Cause resource.", "description": "### Request Body\r\n#### 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 | FailureCause->Version | integer | int32 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| notes | FailureCause->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureCauseTypeId | Nullable | False | |\r\n\r\n", "operationId": "UpdateFailureCause", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFailureCauseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause 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": [ "Failure Cause" ], "summary": "Delete an existing Failure Cause resource.", "description": "### Request Body\r\n#### 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 | FailureCause->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": "DeleteFailureCause", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFailureCauseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause 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/AMPC/FailureCauses": { "get": { "tags": [ "Failure Cause" ], "summary": "Get a collection of Failure Cause 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 | FailureCause->Id | integer | int64 |\r\n| version | FailureCause->Version | integer | int32 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n| notes | FailureCause->Notes | string | |\r\n| permissionTreeCode | FailureCause->PermissionTree_Code | string | |\r\n| createdOn | FailureCause->CreatedOn | string | date-time |\r\n| modifiedOn | FailureCause->ModifiedOn | string | date-time |\r\n", "operationId": "GetFailureCauseCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Cause collection", "schema": { "$ref": "#/definitions/GetFailureCauseCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Failure Cause" ], "summary": "Create a new Failure Cause resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureCause->PermissionTree_Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| notes | FailureCause->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureCauseTypeId | Required | True | |\r\n| failureCauseTypeId | Nullable | False | |\r\n\r\n", "operationId": "CreateFailureCause", "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/CreateFailureCauseResourceActionRequest" } }, { "$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/AMPC/FailureCauses/Lookups/LookupFailureCauseChangePermissionTree": { "get": { "tags": [ "Failure Cause" ], "summary": "Lookup the permission set for changing the Failure Cause.", "description": "### Response Body\r\n#### Payload\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": "LookupFailureCauseChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureCauseChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauses/Lookups/LookupFailureCauseFailureCauseType": { "get": { "tags": [ "Failure Cause" ], "summary": "Lookup the Failure Cause for the Failure Cause.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n", "operationId": "LookupFailureCauseFailureCauseType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Cause Type collection", "schema": { "$ref": "#/definitions/FailureCauseFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauses/Lookups/LookupFailureCauseInsertPermissionTree": { "get": { "tags": [ "Failure Cause" ], "summary": "Lookup the permission set for creating the Failure Cause.", "description": "### Response Body\r\n#### Payload\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": "LookupFailureCauseInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureCauseInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauses/Batch/{ids}": { "get": { "tags": [ "Failure Cause" ], "summary": "Get a collection of Failure Cause resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FailureCause->Code | string | |\r\n| isActive | FailureCause->IsActive | boolean | |\r\n| createdByUserId | FailureCause->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureCause->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureCause->CreatedByUser_FullName | string | |\r\n| createdOn | FailureCause->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureCause->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureCause->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureCause->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureCause->ModifiedOn | string | date-time |\r\n| version | FailureCause->Version | integer | int32 |\r\n| permissionTreeId | FailureCause->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureCause->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureCause->PermissionTree_Description | string | |\r\n| id | FailureCause->Id | integer | int64 |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n| description | FailureCause->Description | string | |\r\n| notes | FailureCause->Notes | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetFailureCause", "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 Failure Cause 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 Failure Cause collection", "schema": { "$ref": "#/definitions/BatchGetFailureCauseResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauses/Batch": { "post": { "tags": [ "Failure Cause" ], "summary": "Create a new collection of Failure Cause resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureCause->PermissionTree_Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| notes | FailureCause->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureCauseTypeId | Required | True | |\r\n| failureCauseTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateFailureCause", "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/BatchCreateFailureCauseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Failure Cause 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": [ "Failure Cause" ], "summary": "Update a collection of existing Failure Cause resources.", "description": "### Request Body\r\n#### 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 | FailureCause->Id | integer | int64 |\r\n| version | FailureCause->Version | integer | int32 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| sequenceNumber | FailureCause->SequenceNumber | integer | int32 |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| notes | FailureCause->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureCauseTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateFailureCause", "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/BatchUpdateFailureCauseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause 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": [ "Failure Cause" ], "summary": "Delete a collection of existing Failure Cause resources.", "description": "### Request Body\r\n#### 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 | FailureCause->Id | integer | int64 |\r\n| version | FailureCause->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": "BatchDeleteFailureCause", "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/BatchDeleteFailureCauseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause 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/AMPC/FailureCauses/{id}/Active": { "patch": { "tags": [ "Failure Cause" ], "summary": "Change the IsActive status for an existing Failure Cause resource.", "description": "### Request Body\r\n#### 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 | FailureCause->Version | integer | int32 |\r\n| isActive | FailureCause->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": "ChangeFailureCauseIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureCauseIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureCauses/{id}/PermissionTree": { "patch": { "tags": [ "Failure Cause" ], "summary": "Change the PermissionTree for an existing Failure Cause resource.", "description": "### Request Body\r\n#### 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 | FailureCause->Version | integer | int32 |\r\n| permissionTreeId | FailureCause->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFailureCausePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureCausePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureCauses/Batch/Active": { "patch": { "tags": [ "Failure Cause" ], "summary": "Change the IsActive status for a collection of existing Failure Cause resources.", "description": "### Request Body\r\n#### 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 | FailureCause->Id | integer | int64 |\r\n| version | FailureCause->Version | integer | int32 |\r\n| isActive | FailureCause->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": "BatchChangeFailureCauseIsActive", "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/BatchChangeFailureCauseIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureCauses/Batch/PermissionTree": { "patch": { "tags": [ "Failure Cause" ], "summary": "Change the PermissionTree status for a collection of existing Failure Cause resources.", "description": "### Request Body\r\n#### 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 | FailureCause->Id | integer | int64 |\r\n| version | FailureCause->Version | integer | int32 |\r\n| permissionTreeId | FailureCause->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFailureCausePermissionTree", "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/BatchChangeFailureCausePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureCauseTypes/{id}": { "get": { "tags": [ "Failure Cause Type" ], "summary": "Get a Failure Cause Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | FailureCauseType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureCauseType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureCauseType->CreatedByUser_FullName | string | |\r\n| createdOn | FailureCauseType->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureCauseType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureCauseType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureCauseType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureCauseType->ModifiedOn | string | date-time |\r\n| permissionTreeId | FailureCauseType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureCauseType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureCauseType->PermissionTree_Description | string | |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| isActive | FailureCauseType->IsActive | boolean | |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| description | FailureCauseType->Description | string | |\r\n| notes | FailureCauseType->Notes | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetFailureCauseType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Cause Type", "schema": { "$ref": "#/definitions/GetFailureCauseTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Cause Type" ], "summary": "Update an existing Failure Cause Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n| notes | FailureCauseType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateFailureCauseType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFailureCauseTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Failure Cause Type" ], "summary": "Delete an existing Failure Cause Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureCauseType->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": "DeleteFailureCauseType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFailureCauseTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauseTypes": { "get": { "tags": [ "Failure Cause Type" ], "summary": "Get a collection of Failure Cause Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n| notes | FailureCauseType->Notes | string | |\r\n| createdOn | FailureCauseType->CreatedOn | string | date-time |\r\n| modifiedOn | FailureCauseType->ModifiedOn | string | date-time |\r\n", "operationId": "GetFailureCauseTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Cause Type collection", "schema": { "$ref": "#/definitions/GetFailureCauseTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Failure Cause Type" ], "summary": "Create a new Failure Cause Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureCauseType->PermissionTree_Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n| notes | FailureCauseType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateFailureCauseType", "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/CreateFailureCauseTypeResourceActionRequest" } }, { "$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/AMPC/FailureCauseTypes/Lookups/LookupFailureCauseTypeChangePermissionTree": { "get": { "tags": [ "Failure Cause Type" ], "summary": "Lookup the permission set for changing the Failure Cause Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFailureCauseTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureCauseTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauseTypes/Lookups/LookupFailureCauseTypeInsertPermissionTree": { "get": { "tags": [ "Failure Cause Type" ], "summary": "Lookup the permission set for creating the Failure Cause Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFailureCauseTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureCauseTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauseTypes/Batch/{ids}": { "get": { "tags": [ "Failure Cause Type" ], "summary": "Get a collection of Failure Cause Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | FailureCauseType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureCauseType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureCauseType->CreatedByUser_FullName | string | |\r\n| createdOn | FailureCauseType->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureCauseType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureCauseType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureCauseType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureCauseType->ModifiedOn | string | date-time |\r\n| permissionTreeId | FailureCauseType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureCauseType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureCauseType->PermissionTree_Description | string | |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| isActive | FailureCauseType->IsActive | boolean | |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| description | FailureCauseType->Description | string | |\r\n| notes | FailureCauseType->Notes | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetFailureCauseType", "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 Failure Cause Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Cause Type collection", "schema": { "$ref": "#/definitions/BatchGetFailureCauseTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauseTypes/Batch": { "post": { "tags": [ "Failure Cause Type" ], "summary": "Create a new collection of Failure Cause Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureCauseType->PermissionTree_Id | integer | int64 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n| notes | FailureCauseType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateFailureCauseType", "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/BatchCreateFailureCauseTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Failure Cause Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Cause Type" ], "summary": "Update a collection of existing Failure Cause Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| code | FailureCauseType->Code | string | |\r\n| description | FailureCauseType->Description | string | |\r\n| sequenceNumber | FailureCauseType->SequenceNumber | integer | int32 |\r\n| notes | FailureCauseType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateFailureCauseType", "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/BatchUpdateFailureCauseTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Failure Cause Type" ], "summary": "Delete a collection of existing Failure Cause Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| version | FailureCauseType->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": "BatchDeleteFailureCauseType", "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/BatchDeleteFailureCauseTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Cause Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureCauseTypes/{id}/Active": { "patch": { "tags": [ "Failure Cause Type" ], "summary": "Change the IsActive status for an existing Failure Cause Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| isActive | FailureCauseType->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": "ChangeFailureCauseTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureCauseTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureCauseTypes/{id}/PermissionTree": { "patch": { "tags": [ "Failure Cause Type" ], "summary": "Change the PermissionTree for an existing Failure Cause Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| permissionTreeId | FailureCauseType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFailureCauseTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Cause Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureCauseTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureCauseTypes/Batch/Active": { "patch": { "tags": [ "Failure Cause Type" ], "summary": "Change the IsActive status for a collection of existing Failure Cause Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| isActive | FailureCauseType->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": "BatchChangeFailureCauseTypeIsActive", "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/BatchChangeFailureCauseTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureCauseTypes/Batch/PermissionTree": { "patch": { "tags": [ "Failure Cause Type" ], "summary": "Change the PermissionTree status for a collection of existing Failure Cause Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCauseType->Id | integer | int64 |\r\n| version | FailureCauseType->Version | integer | int32 |\r\n| permissionTreeId | FailureCauseType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFailureCauseTypePermissionTree", "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/BatchChangeFailureCauseTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureMechanisms/{id}": { "get": { "tags": [ "Failure Mechanism" ], "summary": "Get a Failure Mechanism resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FailureMechanism->Code | string | |\r\n| isActive | FailureMechanism->IsActive | boolean | |\r\n| createdByUserId | FailureMechanism->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureMechanism->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureMechanism->CreatedByUser_FullName | string | |\r\n| createdOn | FailureMechanism->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureMechanism->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureMechanism->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureMechanism->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureMechanism->ModifiedOn | string | date-time |\r\n| version | FailureMechanism->Version | integer | int32 |\r\n| permissionTreeId | FailureMechanism->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureMechanism->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureMechanism->PermissionTree_Description | string | |\r\n| id | FailureMechanism->Id | integer | int64 |\r\n| description | FailureMechanism->Description | string | |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n| notes | FailureMechanism->Notes | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n", "operationId": "GetFailureMechanism", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Mechanism", "schema": { "$ref": "#/definitions/GetFailureMechanismResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Mechanism" ], "summary": "Update an existing Failure Mechanism resource.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Version | integer | int32 |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanism->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| failureMechanismTypeId | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateFailureMechanism", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFailureMechanismResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism 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": [ "Failure Mechanism" ], "summary": "Delete an existing Failure Mechanism resource.", "description": "### Request Body\r\n#### 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 | FailureMechanism->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": "DeleteFailureMechanism", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFailureMechanismResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism 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/AMPC/FailureMechanisms": { "get": { "tags": [ "Failure Mechanism" ], "summary": "Get a collection of Failure Mechanism 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 | FailureMechanism->Id | integer | int64 |\r\n| version | FailureMechanism->Version | integer | int32 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| notes | FailureMechanism->Notes | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n| permissionTreeCode | FailureMechanism->PermissionTree_Code | string | |\r\n| createdOn | FailureMechanism->CreatedOn | string | date-time |\r\n| modifiedOn | FailureMechanism->ModifiedOn | string | date-time |\r\n", "operationId": "GetFailureMechanismCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Mechanism collection", "schema": { "$ref": "#/definitions/GetFailureMechanismCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Failure Mechanism" ], "summary": "Create a new Failure Mechanism resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureMechanism->PermissionTree_Id | integer | int64 |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanism->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| failureMechanismTypeId | Required | True | |\r\n| failureMechanismTypeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateFailureMechanism", "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/CreateFailureMechanismResourceActionRequest" } }, { "$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/AMPC/FailureMechanisms/Lookups/LookupFailureMechanismChangePermissionTree": { "get": { "tags": [ "Failure Mechanism" ], "summary": "Lookup the permission set for changing the Failure Mechanism.", "description": "### Response Body\r\n#### Payload\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": "LookupFailureMechanismChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureMechanismChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanisms/Lookups/LookupFailureMechanismFailureMechanismType": { "get": { "tags": [ "Failure Mechanism" ], "summary": "Lookup the Failure Mechanism Type for the Failure Mechanism.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n", "operationId": "LookupFailureMechanismFailureMechanismType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Mechanism Type collection", "schema": { "$ref": "#/definitions/FailureMechanismFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanisms/Lookups/LookupFailureMechanismInsertPermissionTree": { "get": { "tags": [ "Failure Mechanism" ], "summary": "Lookup the permission set for creating the Failure Mechanism.", "description": "### Response Body\r\n#### Payload\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": "LookupFailureMechanismInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureMechanismInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanisms/Batch/{ids}": { "get": { "tags": [ "Failure Mechanism" ], "summary": "Get a collection of Failure Mechanism resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FailureMechanism->Code | string | |\r\n| isActive | FailureMechanism->IsActive | boolean | |\r\n| createdByUserId | FailureMechanism->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureMechanism->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureMechanism->CreatedByUser_FullName | string | |\r\n| createdOn | FailureMechanism->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureMechanism->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureMechanism->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureMechanism->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureMechanism->ModifiedOn | string | date-time |\r\n| version | FailureMechanism->Version | integer | int32 |\r\n| permissionTreeId | FailureMechanism->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureMechanism->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureMechanism->PermissionTree_Description | string | |\r\n| id | FailureMechanism->Id | integer | int64 |\r\n| description | FailureMechanism->Description | string | |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n| notes | FailureMechanism->Notes | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetFailureMechanism", "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 Failure Mechanism 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 Failure Mechanism collection", "schema": { "$ref": "#/definitions/BatchGetFailureMechanismResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanisms/Batch": { "post": { "tags": [ "Failure Mechanism" ], "summary": "Create a new collection of Failure Mechanism resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureMechanism->PermissionTree_Id | integer | int64 |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanism->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| failureMechanismTypeId | Required | True | |\r\n| failureMechanismTypeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateFailureMechanism", "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/BatchCreateFailureMechanismResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Failure Mechanism 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": [ "Failure Mechanism" ], "summary": "Update a collection of existing Failure Mechanism resources.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Id | integer | int64 |\r\n| version | FailureMechanism->Version | integer | int32 |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| sequenceNumber | FailureMechanism->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanism->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| failureMechanismTypeId | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateFailureMechanism", "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/BatchUpdateFailureMechanismResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism 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": [ "Failure Mechanism" ], "summary": "Delete a collection of existing Failure Mechanism resources.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Id | integer | int64 |\r\n| version | FailureMechanism->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": "BatchDeleteFailureMechanism", "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/BatchDeleteFailureMechanismResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism 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/AMPC/FailureMechanisms/{id}/Active": { "patch": { "tags": [ "Failure Mechanism" ], "summary": "Change the IsActive status for an existing Failure Mechanism resource.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Version | integer | int32 |\r\n| isActive | FailureMechanism->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": "ChangeFailureMechanismIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureMechanismIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureMechanisms/{id}/PermissionTree": { "patch": { "tags": [ "Failure Mechanism" ], "summary": "Change the PermissionTree for an existing Failure Mechanism resource.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Version | integer | int32 |\r\n| permissionTreeId | FailureMechanism->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFailureMechanismPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureMechanismPermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureMechanisms/Batch/Active": { "patch": { "tags": [ "Failure Mechanism" ], "summary": "Change the IsActive status for a collection of existing Failure Mechanism resources.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Id | integer | int64 |\r\n| version | FailureMechanism->Version | integer | int32 |\r\n| isActive | FailureMechanism->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": "BatchChangeFailureMechanismIsActive", "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/BatchChangeFailureMechanismIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureMechanisms/Batch/PermissionTree": { "patch": { "tags": [ "Failure Mechanism" ], "summary": "Change the PermissionTree status for a collection of existing Failure Mechanism resources.", "description": "### Request Body\r\n#### 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 | FailureMechanism->Id | integer | int64 |\r\n| version | FailureMechanism->Version | integer | int32 |\r\n| permissionTreeId | FailureMechanism->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFailureMechanismPermissionTree", "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/BatchChangeFailureMechanismPermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureMechanismTypes/{id}": { "get": { "tags": [ "Failure Mechanism Type" ], "summary": "Get a Failure Mechanism Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | FailureMechanismType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureMechanismType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureMechanismType->CreatedByUser_FullName | string | |\r\n| createdOn | FailureMechanismType->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureMechanismType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureMechanismType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureMechanismType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureMechanismType->ModifiedOn | string | date-time |\r\n| permissionTreeId | FailureMechanismType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureMechanismType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureMechanismType->PermissionTree_Description | string | |\r\n| code | FailureMechanismType->Code | string | |\r\n| isActive | FailureMechanismType->IsActive | boolean | |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| description | FailureMechanismType->Description | string | |\r\n| notes | FailureMechanismType->Notes | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetFailureMechanismType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Mechanism Type", "schema": { "$ref": "#/definitions/GetFailureMechanismTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Mechanism Type" ], "summary": "Update an existing Failure Mechanism Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanismType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateFailureMechanismType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFailureMechanismTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Failure Mechanism Type" ], "summary": "Delete an existing Failure Mechanism Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureMechanismType->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": "DeleteFailureMechanismType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFailureMechanismTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanismTypes": { "get": { "tags": [ "Failure Mechanism Type" ], "summary": "Get a collection of Failure Mechanism Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanismType->Notes | string | |\r\n| permissionTreeCode | FailureMechanismType->PermissionTree_Code | string | |\r\n| createdOn | FailureMechanismType->CreatedOn | string | date-time |\r\n| modifiedOn | FailureMechanismType->ModifiedOn | string | date-time |\r\n", "operationId": "GetFailureMechanismTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Mechanism Type collection", "schema": { "$ref": "#/definitions/GetFailureMechanismTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Failure Mechanism Type" ], "summary": "Create a new Failure Mechanism Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureMechanismType->PermissionTree_Id | integer | int64 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanismType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateFailureMechanismType", "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/CreateFailureMechanismTypeResourceActionRequest" } }, { "$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/AMPC/FailureMechanismTypes/Lookups/LookupFailureMechanismTypeChangePermissionTree": { "get": { "tags": [ "Failure Mechanism Type" ], "summary": "Lookup the permission set for changing the Failure Mechanism Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFailureMechanismTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureMechanismTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanismTypes/Lookups/LookupFailureMechanismTypeInsertPermissionTree": { "get": { "tags": [ "Failure Mechanism Type" ], "summary": "Lookup the permission set for creating the Failure Mechanism Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFailureMechanismTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureMechanismTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanismTypes/Batch/{ids}": { "get": { "tags": [ "Failure Mechanism Type" ], "summary": "Get a collection of Failure Mechanism Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | FailureMechanismType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureMechanismType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureMechanismType->CreatedByUser_FullName | string | |\r\n| createdOn | FailureMechanismType->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureMechanismType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureMechanismType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureMechanismType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureMechanismType->ModifiedOn | string | date-time |\r\n| permissionTreeId | FailureMechanismType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureMechanismType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureMechanismType->PermissionTree_Description | string | |\r\n| code | FailureMechanismType->Code | string | |\r\n| isActive | FailureMechanismType->IsActive | boolean | |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| description | FailureMechanismType->Description | string | |\r\n| notes | FailureMechanismType->Notes | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetFailureMechanismType", "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 Failure Mechanism Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Mechanism Type collection", "schema": { "$ref": "#/definitions/BatchGetFailureMechanismTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanismTypes/Batch": { "post": { "tags": [ "Failure Mechanism Type" ], "summary": "Create a new collection of Failure Mechanism Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureMechanismType->PermissionTree_Id | integer | int64 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanismType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateFailureMechanismType", "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/BatchCreateFailureMechanismTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Failure Mechanism Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Mechanism Type" ], "summary": "Update a collection of existing Failure Mechanism Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| code | FailureMechanismType->Code | string | |\r\n| description | FailureMechanismType->Description | string | |\r\n| sequenceNumber | FailureMechanismType->SequenceNumber | integer | int32 |\r\n| notes | FailureMechanismType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateFailureMechanismType", "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/BatchUpdateFailureMechanismTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Failure Mechanism Type" ], "summary": "Delete a collection of existing Failure Mechanism Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->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": "BatchDeleteFailureMechanismType", "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/BatchDeleteFailureMechanismTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mechanism Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureMechanismTypes/{id}/Active": { "patch": { "tags": [ "Failure Mechanism Type" ], "summary": "Change the IsActive status for an existing Failure Mechanism Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| isActive | FailureMechanismType->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": "ChangeFailureMechanismTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureMechanismTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureMechanismTypes/{id}/PermissionTree": { "patch": { "tags": [ "Failure Mechanism Type" ], "summary": "Change the PermissionTree for an existing Failure Mechanism Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| permissionTreeId | FailureMechanismType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFailureMechanismTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mechanism Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureMechanismTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureMechanismTypes/Batch/Active": { "patch": { "tags": [ "Failure Mechanism Type" ], "summary": "Change the IsActive status for a collection of existing Failure Mechanism Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| isActive | FailureMechanismType->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": "BatchChangeFailureMechanismTypeIsActive", "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/BatchChangeFailureMechanismTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureMechanismTypes/Batch/PermissionTree": { "patch": { "tags": [ "Failure Mechanism Type" ], "summary": "Change the PermissionTree status for a collection of existing Failure Mechanism Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanismType->Id | integer | int64 |\r\n| version | FailureMechanismType->Version | integer | int32 |\r\n| permissionTreeId | FailureMechanismType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFailureMechanismTypePermissionTree", "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/BatchChangeFailureMechanismTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureModes/{id}": { "get": { "tags": [ "Failure Mode" ], "summary": "Get a Failure Mode resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FailureMode->Code | string | |\r\n| isActive | FailureMode->IsActive | boolean | |\r\n| createdByUserId | FailureMode->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureMode->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureMode->CreatedByUser_FullName | string | |\r\n| createdOn | FailureMode->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureMode->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureMode->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureMode->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureMode->ModifiedOn | string | date-time |\r\n| version | FailureMode->Version | integer | int32 |\r\n| permissionTreeId | FailureMode->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureMode->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureMode->PermissionTree_Description | string | |\r\n| id | FailureMode->Id | integer | int64 |\r\n| description | FailureMode->Description | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n| notes | FailureMode->Notes | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n", "operationId": "GetFailureMode", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Mode", "schema": { "$ref": "#/definitions/GetFailureModeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Mode" ], "summary": "Update an existing Failure Mode resource.", "description": "### Request Body\r\n#### 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 | FailureMode->Version | integer | int32 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| notes | FailureMode->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureModeTypeId | Nullable | False | |\r\n\r\n", "operationId": "UpdateFailureMode", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFailureModeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode 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": [ "Failure Mode" ], "summary": "Delete an existing Failure Mode resource.", "description": "### Request Body\r\n#### 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 | FailureMode->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": "DeleteFailureMode", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFailureModeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode 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/AMPC/FailureModes": { "get": { "tags": [ "Failure Mode" ], "summary": "Get a collection of Failure Mode 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 | FailureMode->Id | integer | int64 |\r\n| version | FailureMode->Version | integer | int32 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| permissionTreeCode | FailureMode->PermissionTree_Code | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n| notes | FailureMode->Notes | string | |\r\n| createdOn | FailureMode->CreatedOn | string | date-time |\r\n| modifiedOn | FailureMode->ModifiedOn | string | date-time |\r\n", "operationId": "GetFailureModeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Mode collection", "schema": { "$ref": "#/definitions/GetFailureModeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Failure Mode" ], "summary": "Create a new Failure Mode resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureMode->PermissionTree_Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| notes | FailureMode->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureModeTypeId | Required | True | |\r\n| failureModeTypeId | Nullable | False | |\r\n\r\n", "operationId": "CreateFailureMode", "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/CreateFailureModeResourceActionRequest" } }, { "$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/AMPC/FailureModes/Lookups/LookupFailureModeChangePermissionTree": { "get": { "tags": [ "Failure Mode" ], "summary": "Lookup the permission set for changing the Failure Mode.", "description": "### Response Body\r\n#### Payload\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": "LookupFailureModeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureModeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModes/Lookups/LookupFailureModeFailureModeType": { "get": { "tags": [ "Failure Mode" ], "summary": "Lookup the Failure Mode for the Failure Mode.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n", "operationId": "LookupFailureModeFailureModeType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Mode Type collection", "schema": { "$ref": "#/definitions/FailureModeFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModes/Lookups/LookupFailureModeInsertPermissionTree": { "get": { "tags": [ "Failure Mode" ], "summary": "Lookup the permission set for creating the Failure Mode.", "description": "### Response Body\r\n#### Payload\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": "LookupFailureModeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureModeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModes/Batch/{ids}": { "get": { "tags": [ "Failure Mode" ], "summary": "Get a collection of Failure Mode resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | FailureMode->Code | string | |\r\n| isActive | FailureMode->IsActive | boolean | |\r\n| createdByUserId | FailureMode->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureMode->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureMode->CreatedByUser_FullName | string | |\r\n| createdOn | FailureMode->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureMode->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureMode->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureMode->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureMode->ModifiedOn | string | date-time |\r\n| version | FailureMode->Version | integer | int32 |\r\n| permissionTreeId | FailureMode->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureMode->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureMode->PermissionTree_Description | string | |\r\n| id | FailureMode->Id | integer | int64 |\r\n| description | FailureMode->Description | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n| notes | FailureMode->Notes | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetFailureMode", "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 Failure Mode 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 Failure Mode collection", "schema": { "$ref": "#/definitions/BatchGetFailureModeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModes/Batch": { "post": { "tags": [ "Failure Mode" ], "summary": "Create a new collection of Failure Mode resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureMode->PermissionTree_Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| notes | FailureMode->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureModeTypeId | Required | True | |\r\n| failureModeTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateFailureMode", "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/BatchCreateFailureModeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Failure Mode 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": [ "Failure Mode" ], "summary": "Update a collection of existing Failure Mode resources.", "description": "### Request Body\r\n#### 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 | FailureMode->Id | integer | int64 |\r\n| version | FailureMode->Version | integer | int32 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| sequenceNumber | FailureMode->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| notes | FailureMode->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| failureModeTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateFailureMode", "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/BatchUpdateFailureModeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode 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": [ "Failure Mode" ], "summary": "Delete a collection of existing Failure Mode resources.", "description": "### Request Body\r\n#### 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 | FailureMode->Id | integer | int64 |\r\n| version | FailureMode->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": "BatchDeleteFailureMode", "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/BatchDeleteFailureModeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode 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/AMPC/FailureModes/{id}/Active": { "patch": { "tags": [ "Failure Mode" ], "summary": "Change the IsActive status for an existing Failure Mode resource.", "description": "### Request Body\r\n#### 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 | FailureMode->Version | integer | int32 |\r\n| isActive | FailureMode->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": "ChangeFailureModeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureModeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureModes/{id}/PermissionTree": { "patch": { "tags": [ "Failure Mode" ], "summary": "Change the PermissionTree for an existing Failure Mode resource.", "description": "### Request Body\r\n#### 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 | FailureMode->Version | integer | int32 |\r\n| permissionTreeId | FailureMode->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFailureModePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureModePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureModes/Batch/Active": { "patch": { "tags": [ "Failure Mode" ], "summary": "Change the IsActive status for a collection of existing Failure Mode resources.", "description": "### Request Body\r\n#### 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 | FailureMode->Id | integer | int64 |\r\n| version | FailureMode->Version | integer | int32 |\r\n| isActive | FailureMode->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": "BatchChangeFailureModeIsActive", "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/BatchChangeFailureModeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureModes/Batch/PermissionTree": { "patch": { "tags": [ "Failure Mode" ], "summary": "Change the PermissionTree status for a collection of existing Failure Mode resources.", "description": "### Request Body\r\n#### 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 | FailureMode->Id | integer | int64 |\r\n| version | FailureMode->Version | integer | int32 |\r\n| permissionTreeId | FailureMode->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFailureModePermissionTree", "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/BatchChangeFailureModePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureModeTypes/{id}": { "get": { "tags": [ "Failure Mode Type" ], "summary": "Get a Failure Mode Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| isActive | FailureModeType->IsActive | boolean | |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| permissionTreeId | FailureModeType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureModeType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureModeType->PermissionTree_Description | string | |\r\n| createdByUserId | FailureModeType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureModeType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureModeType->CreatedByUser_FullName | string | |\r\n| createdOn | FailureModeType->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureModeType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureModeType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureModeType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureModeType->ModifiedOn | string | date-time |\r\n| description | FailureModeType->Description | string | |\r\n| notes | FailureModeType->Notes | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetFailureModeType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Mode Type", "schema": { "$ref": "#/definitions/GetFailureModeTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Mode Type" ], "summary": "Update an existing Failure Mode Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n| notes | FailureModeType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateFailureModeType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateFailureModeTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Failure Mode Type" ], "summary": "Delete an existing Failure Mode Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureModeType->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": "DeleteFailureModeType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteFailureModeTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModeTypes": { "get": { "tags": [ "Failure Mode Type" ], "summary": "Get a collection of Failure Mode Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n| notes | FailureModeType->Notes | string | |\r\n| permissionTreeCode | FailureModeType->PermissionTree_Code | string | |\r\n| createdOn | FailureModeType->CreatedOn | string | date-time |\r\n| modifiedOn | FailureModeType->ModifiedOn | string | date-time |\r\n", "operationId": "GetFailureModeTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Failure Mode Type collection", "schema": { "$ref": "#/definitions/GetFailureModeTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Failure Mode Type" ], "summary": "Create a new Failure Mode Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureModeType->PermissionTree_Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n| notes | FailureModeType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateFailureModeType", "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/CreateFailureModeTypeResourceActionRequest" } }, { "$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/AMPC/FailureModeTypes/Lookups/LookupFailureModeTypeChangePermissionTree": { "get": { "tags": [ "Failure Mode Type" ], "summary": "Lookup the permission set for changing the Failure Mode Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFailureModeTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureModeTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModeTypes/Lookups/LookupFailureModeTypeInsertPermissionTree": { "get": { "tags": [ "Failure Mode Type" ], "summary": "Lookup the permission set for creating the Failure Mode Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupFailureModeTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/FailureModeTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModeTypes/Batch/{ids}": { "get": { "tags": [ "Failure Mode Type" ], "summary": "Get a collection of Failure Mode Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| isActive | FailureModeType->IsActive | boolean | |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| permissionTreeId | FailureModeType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | FailureModeType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | FailureModeType->PermissionTree_Description | string | |\r\n| createdByUserId | FailureModeType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | FailureModeType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | FailureModeType->CreatedByUser_FullName | string | |\r\n| createdOn | FailureModeType->CreatedOn | string | date-time |\r\n| modifiedByUserId | FailureModeType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | FailureModeType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | FailureModeType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | FailureModeType->ModifiedOn | string | date-time |\r\n| description | FailureModeType->Description | string | |\r\n| notes | FailureModeType->Notes | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetFailureModeType", "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 Failure Mode Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Failure Mode Type collection", "schema": { "$ref": "#/definitions/BatchGetFailureModeTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModeTypes/Batch": { "post": { "tags": [ "Failure Mode Type" ], "summary": "Create a new collection of Failure Mode Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | FailureModeType->PermissionTree_Id | integer | int64 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n| notes | FailureModeType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateFailureModeType", "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/BatchCreateFailureModeTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Failure Mode Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Failure Mode Type" ], "summary": "Update a collection of existing Failure Mode Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| code | FailureModeType->Code | string | |\r\n| description | FailureModeType->Description | string | |\r\n| sequenceNumber | FailureModeType->SequenceNumber | integer | int32 |\r\n| notes | FailureModeType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateFailureModeType", "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/BatchUpdateFailureModeTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Failure Mode Type" ], "summary": "Delete a collection of existing Failure Mode Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| version | FailureModeType->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": "BatchDeleteFailureModeType", "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/BatchDeleteFailureModeTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Failure Mode Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/FailureModeTypes/{id}/Active": { "patch": { "tags": [ "Failure Mode Type" ], "summary": "Change the IsActive status for an existing Failure Mode Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| isActive | FailureModeType->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": "ChangeFailureModeTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureModeTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureModeTypes/{id}/PermissionTree": { "patch": { "tags": [ "Failure Mode Type" ], "summary": "Change the PermissionTree for an existing Failure Mode Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| permissionTreeId | FailureModeType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeFailureModeTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Failure Mode Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeFailureModeTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/FailureModeTypes/Batch/Active": { "patch": { "tags": [ "Failure Mode Type" ], "summary": "Change the IsActive status for a collection of existing Failure Mode Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| isActive | FailureModeType->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": "BatchChangeFailureModeTypeIsActive", "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/BatchChangeFailureModeTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/FailureModeTypes/Batch/PermissionTree": { "patch": { "tags": [ "Failure Mode Type" ], "summary": "Change the PermissionTree status for a collection of existing Failure Mode Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureModeType->Id | integer | int64 |\r\n| version | FailureModeType->Version | integer | int32 |\r\n| permissionTreeId | FailureModeType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeFailureModeTypePermissionTree", "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/BatchChangeFailureModeTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/Options/{id}": { "get": { "tags": [ "Option" ], "summary": "Get a 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| code | Option->Code | string | |\r\n| isActive | Option->IsActive | boolean | |\r\n| createdByUserId | Option->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Option->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Option->CreatedByUser_FullName | string | |\r\n| createdOn | Option->CreatedOn | string | date-time |\r\n| modifiedByUserId | Option->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Option->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Option->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Option->ModifiedOn | string | date-time |\r\n| version | Option->Version | integer | int32 |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| id | Option->Id | integer | int64 |\r\n| permissionTreeId | Option->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Option->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Option->PermissionTree_Description | string | |\r\n| description | Option->Description | string | |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| notes | Option->Notes | string | |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| optionCategoryCode | Option->OptionCategory_Code | string | |\r\n| optionCategoryDescription | Option->OptionCategory_Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Option->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Option->UnitOfMeasurement_Description | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n", "operationId": "GetOption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Option", "schema": { "$ref": "#/definitions/GetOptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Option" ], "summary": "Update an existing 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 | Option->Version | integer | int32 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n| notes | Option->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| optionCategoryId | Nullable | False | |\r\n| dataType | Nullable | False | |\r\n| lowerBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| upperBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| allowMultipleValues | Nullable | False | |\r\n\r\n", "operationId": "UpdateOption", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateOptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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": [ "Option" ], "summary": "Delete an existing 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 | Option->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": "DeleteOption", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteOptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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/AMPC/Options": { "get": { "tags": [ "Option" ], "summary": "Get a collection of Option 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 | Option->Id | integer | int64 |\r\n| version | Option->Version | integer | int32 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| notes | Option->Notes | string | |\r\n| optionCategoryCode | Option->OptionCategory_Code | string | |\r\n| optionCategoryDescription | Option->OptionCategory_Description | string | |\r\n| createdOn | Option->CreatedOn | string | date-time |\r\n| modifiedOn | Option->ModifiedOn | string | date-time |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementCode | Option->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Option->UnitOfMeasurement_Description | string | |\r\n", "operationId": "GetOptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Option collection", "schema": { "$ref": "#/definitions/GetOptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Option" ], "summary": "Create a new 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| permissionTreeId | Option->PermissionTree_Id | integer | int64 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n| notes | Option->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| optionCategoryId | Required | True | |\r\n| optionCategoryId | Nullable | False | |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| lowerBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| upperBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| allowMultipleValues | Required | True | |\r\n| allowMultipleValues | Nullable | False | |\r\n\r\n", "operationId": "CreateOption", "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/CreateOptionResourceActionRequest" } }, { "$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/AMPC/Options/Lookups/LookupOptionChangePermissionTree": { "get": { "tags": [ "Option" ], "summary": "Lookup the permission set for changing the 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 | 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": "LookupOptionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/OptionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Options/Lookups/LookupOptionInsertPermissionTree": { "get": { "tags": [ "Option" ], "summary": "Lookup the permission set for creating the 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 | 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": "LookupOptionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/OptionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Options/Lookups/LookupOptionOptionCategory": { "get": { "tags": [ "Option" ], "summary": "Lookup the Option Category for the 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 | OptionCategory->Id | integer | int64 |\r\n| code | OptionCategory->Code | string | |\r\n| description | OptionCategory->Description | string | |\r\n", "operationId": "LookupOptionOptionCategory", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Option Category collection", "schema": { "$ref": "#/definitions/OptionOptionCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Options/Lookups/LookupOptionUnitOfMeasurement": { "get": { "tags": [ "Option" ], "summary": "Lookup the Unit Of Measurement for the 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 | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupOptionUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/OptionUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Options/Batch/{ids}": { "get": { "tags": [ "Option" ], "summary": "Get a collection of Option resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Option->Code | string | |\r\n| isActive | Option->IsActive | boolean | |\r\n| createdByUserId | Option->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Option->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Option->CreatedByUser_FullName | string | |\r\n| createdOn | Option->CreatedOn | string | date-time |\r\n| modifiedByUserId | Option->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Option->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Option->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Option->ModifiedOn | string | date-time |\r\n| version | Option->Version | integer | int32 |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| id | Option->Id | integer | int64 |\r\n| permissionTreeId | Option->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Option->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Option->PermissionTree_Description | string | |\r\n| description | Option->Description | string | |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| notes | Option->Notes | string | |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| optionCategoryCode | Option->OptionCategory_Code | string | |\r\n| optionCategoryDescription | Option->OptionCategory_Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Option->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Option->UnitOfMeasurement_Description | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n", "operationId": "BatchGetOption", "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 Option 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 Option collection", "schema": { "$ref": "#/definitions/BatchGetOptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Options/Batch": { "post": { "tags": [ "Option" ], "summary": "Create a new collection of Option resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Option->PermissionTree_Id | integer | int64 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n| notes | Option->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| optionCategoryId | Required | True | |\r\n| optionCategoryId | Nullable | False | |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| lowerBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| upperBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| allowMultipleValues | Required | True | |\r\n| allowMultipleValues | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateOption", "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/BatchCreateOptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Option 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": [ "Option" ], "summary": "Update a collection of existing Option resources.", "description": "### Request Body\r\n#### 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 | Option->Id | integer | int64 |\r\n| version | Option->Version | integer | int32 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| sequenceNumber | Option->SequenceNumber | integer | int32 |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n| notes | Option->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| optionCategoryId | Nullable | False | |\r\n| dataType | Nullable | False | |\r\n| lowerBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| upperBounds | Nullable | True | Option->DataType = 'String' OR Option->DataType = 'Boolean' |\r\n| allowMultipleValues | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateOption", "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/BatchUpdateOptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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": [ "Option" ], "summary": "Delete a collection of existing Option resources.", "description": "### Request Body\r\n#### 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 | Option->Id | integer | int64 |\r\n| version | Option->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": "BatchDeleteOption", "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/BatchDeleteOptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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/AMPC/Options/{id}/Active": { "patch": { "tags": [ "Option" ], "summary": "Change the IsActive status for an existing 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 | Option->Version | integer | int32 |\r\n| isActive | Option->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": "ChangeOptionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeOptionIsActiveResourceActionRequest" } }, { "$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/AMPC/Options/{id}/PermissionTree": { "patch": { "tags": [ "Option" ], "summary": "Change the PermissionTree for an existing 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 | Option->Version | integer | int32 |\r\n| permissionTreeId | Option->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeOptionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeOptionPermissionTreeResourceActionRequest" } }, { "$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/AMPC/Options/Batch/Active": { "patch": { "tags": [ "Option" ], "summary": "Change the IsActive status for a collection of existing Option resources.", "description": "### Request Body\r\n#### 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 | Option->Id | integer | int64 |\r\n| version | Option->Version | integer | int32 |\r\n| isActive | Option->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": "BatchChangeOptionIsActive", "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/BatchChangeOptionIsActiveResourceActionRequest" } }, { "$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/AMPC/Options/Batch/PermissionTree": { "patch": { "tags": [ "Option" ], "summary": "Change the PermissionTree status for a collection of existing Option resources.", "description": "### Request Body\r\n#### 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 | Option->Id | integer | int64 |\r\n| version | Option->Version | integer | int32 |\r\n| permissionTreeId | Option->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeOptionPermissionTree", "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/BatchChangeOptionPermissionTreeResourceActionRequest" } }, { "$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/AMPC/OptionCategories/{id}": { "get": { "tags": [ "Option Category" ], "summary": "Get a Option 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 | OptionCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OptionCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OptionCategory->CreatedByUser_FullName | string | |\r\n| createdOn | OptionCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | OptionCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OptionCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OptionCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OptionCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | OptionCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | OptionCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | OptionCategory->PermissionTree_Description | string | |\r\n| id | OptionCategory->Id | integer | int64 |\r\n| code | OptionCategory->Code | string | |\r\n| isActive | OptionCategory->IsActive | boolean | |\r\n| version | OptionCategory->Version | integer | int32 |\r\n| description | OptionCategory->Description | string | |\r\n| notes | OptionCategory->Notes | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "GetOptionCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Option Category", "schema": { "$ref": "#/definitions/GetOptionCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Option Category" ], "summary": "Update an existing Option 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 | OptionCategory->Version | integer | int32 |\r\n| code | OptionCategory->Code | string | |\r\n| description | OptionCategory->Description | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n| notes | OptionCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateOptionCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateOptionCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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": [ "Option Category" ], "summary": "Delete an existing Option 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 | OptionCategory->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": "DeleteOptionCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteOptionCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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/AMPC/OptionCategories": { "get": { "tags": [ "Option Category" ], "summary": "Get a collection of Option 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 | OptionCategory->Id | integer | int64 |\r\n| version | OptionCategory->Version | integer | int32 |\r\n| code | OptionCategory->Code | string | |\r\n| description | OptionCategory->Description | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n| notes | OptionCategory->Notes | string | |\r\n| createdOn | OptionCategory->CreatedOn | string | date-time |\r\n| modifiedOn | OptionCategory->ModifiedOn | string | date-time |\r\n", "operationId": "GetOptionCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Option Category collection", "schema": { "$ref": "#/definitions/GetOptionCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Option Category" ], "summary": "Create a new Option Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | OptionCategory->PermissionTree_Id | integer | int64 |\r\n| code | OptionCategory->Code | string | |\r\n| description | OptionCategory->Description | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n| notes | OptionCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateOptionCategory", "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/CreateOptionCategoryResourceActionRequest" } }, { "$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/AMPC/OptionCategories/Lookups/LookupOptionCategoryChangePermissionTree": { "get": { "tags": [ "Option Category" ], "summary": "Lookup the permission set for changing the Option Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupOptionCategoryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/OptionCategoryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/OptionCategories/Lookups/LookupOptionCategoryInsertPermissionTree": { "get": { "tags": [ "Option Category" ], "summary": "Lookup the permission set for creating the Option Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupOptionCategoryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/OptionCategoryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/OptionCategories/Batch/{ids}": { "get": { "tags": [ "Option Category" ], "summary": "Get a collection of Option 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 | OptionCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OptionCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OptionCategory->CreatedByUser_FullName | string | |\r\n| createdOn | OptionCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | OptionCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OptionCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OptionCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OptionCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | OptionCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | OptionCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | OptionCategory->PermissionTree_Description | string | |\r\n| id | OptionCategory->Id | integer | int64 |\r\n| code | OptionCategory->Code | string | |\r\n| isActive | OptionCategory->IsActive | boolean | |\r\n| version | OptionCategory->Version | integer | int32 |\r\n| description | OptionCategory->Description | string | |\r\n| notes | OptionCategory->Notes | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetOptionCategory", "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 Option 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 Option Category collection", "schema": { "$ref": "#/definitions/BatchGetOptionCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/OptionCategories/Batch": { "post": { "tags": [ "Option Category" ], "summary": "Create a new collection of Option Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | OptionCategory->PermissionTree_Id | integer | int64 |\r\n| code | OptionCategory->Code | string | |\r\n| description | OptionCategory->Description | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n| notes | OptionCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateOptionCategory", "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/BatchCreateOptionCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Option 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": [ "Option Category" ], "summary": "Update a collection of existing Option 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 | OptionCategory->Id | integer | int64 |\r\n| version | OptionCategory->Version | integer | int32 |\r\n| code | OptionCategory->Code | string | |\r\n| description | OptionCategory->Description | string | |\r\n| sequenceNumber | OptionCategory->SequenceNumber | integer | int32 |\r\n| notes | OptionCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateOptionCategory", "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/BatchUpdateOptionCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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": [ "Option Category" ], "summary": "Delete a collection of existing Option 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 | OptionCategory->Id | integer | int64 |\r\n| version | OptionCategory->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": "BatchDeleteOptionCategory", "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/BatchDeleteOptionCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Option 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/AMPC/OptionCategories/{id}/Active": { "patch": { "tags": [ "Option Category" ], "summary": "Change the IsActive status for an existing Option 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 | OptionCategory->Version | integer | int32 |\r\n| isActive | OptionCategory->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": "ChangeOptionCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeOptionCategoryIsActiveResourceActionRequest" } }, { "$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/AMPC/OptionCategories/{id}/PermissionTree": { "patch": { "tags": [ "Option Category" ], "summary": "Change the PermissionTree for an existing Option 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 | OptionCategory->Version | integer | int32 |\r\n| permissionTreeId | OptionCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeOptionCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Option Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeOptionCategoryPermissionTreeResourceActionRequest" } }, { "$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/AMPC/OptionCategories/Batch/Active": { "patch": { "tags": [ "Option Category" ], "summary": "Change the IsActive status for a collection of existing Option 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 | OptionCategory->Id | integer | int64 |\r\n| version | OptionCategory->Version | integer | int32 |\r\n| isActive | OptionCategory->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": "BatchChangeOptionCategoryIsActive", "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/BatchChangeOptionCategoryIsActiveResourceActionRequest" } }, { "$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/AMPC/OptionCategories/Batch/PermissionTree": { "patch": { "tags": [ "Option Category" ], "summary": "Change the PermissionTree status for a collection of existing Option 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 | OptionCategory->Id | integer | int64 |\r\n| version | OptionCategory->Version | integer | int32 |\r\n| permissionTreeId | OptionCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeOptionCategoryPermissionTree", "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/BatchChangeOptionCategoryPermissionTreeResourceActionRequest" } }, { "$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/AMPC/RepairTypes/{id}": { "get": { "tags": [ "Repair Type" ], "summary": "Get a Repair Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RepairType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RepairType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RepairType->CreatedByUser_FullName | string | |\r\n| createdOn | RepairType->CreatedOn | string | date-time |\r\n| code | RepairType->Code | string | |\r\n| isActive | RepairType->IsActive | boolean | |\r\n| modifiedByUserId | RepairType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RepairType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RepairType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RepairType->ModifiedOn | string | date-time |\r\n| permissionTreeId | RepairType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RepairType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RepairType->PermissionTree_Description | string | |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->Version | integer | int32 |\r\n| description | RepairType->Description | string | |\r\n| notes | RepairType->Notes | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRepairType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Repair Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Repair Type", "schema": { "$ref": "#/definitions/GetRepairTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Repair Type" ], "summary": "Update an existing Repair Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RepairType->Version | integer | int32 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n| notes | RepairType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateRepairType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Repair Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRepairTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Repair Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Repair Type" ], "summary": "Delete an existing Repair Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RepairType->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": "DeleteRepairType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Repair Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRepairTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Repair Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RepairTypes": { "get": { "tags": [ "Repair Type" ], "summary": "Get a collection of Repair Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->Version | integer | int32 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n| permissionTreeCode | RepairType->PermissionTree_Code | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n| notes | RepairType->Notes | string | |\r\n| createdOn | RepairType->CreatedOn | string | date-time |\r\n| modifiedOn | RepairType->ModifiedOn | string | date-time |\r\n", "operationId": "GetRepairTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Repair Type collection", "schema": { "$ref": "#/definitions/GetRepairTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Repair Type" ], "summary": "Create a new Repair Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RepairType->PermissionTree_Id | integer | int64 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n| notes | RepairType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateRepairType", "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/CreateRepairTypeResourceActionRequest" } }, { "$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/AMPC/RepairTypes/Lookups/LookupRepairTypeChangePermissionTree": { "get": { "tags": [ "Repair Type" ], "summary": "Lookup the permission set for changing the Repair Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRepairTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RepairTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RepairTypes/Lookups/LookupRepairTypeInsertPermissionTree": { "get": { "tags": [ "Repair Type" ], "summary": "Lookup the permission set for creating the Repair Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRepairTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RepairTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RepairTypes/Batch/{ids}": { "get": { "tags": [ "Repair Type" ], "summary": "Get a collection of Repair Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RepairType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RepairType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RepairType->CreatedByUser_FullName | string | |\r\n| createdOn | RepairType->CreatedOn | string | date-time |\r\n| code | RepairType->Code | string | |\r\n| isActive | RepairType->IsActive | boolean | |\r\n| modifiedByUserId | RepairType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RepairType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RepairType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RepairType->ModifiedOn | string | date-time |\r\n| permissionTreeId | RepairType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RepairType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RepairType->PermissionTree_Description | string | |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->Version | integer | int32 |\r\n| description | RepairType->Description | string | |\r\n| notes | RepairType->Notes | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRepairType", "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 Repair Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Repair Type collection", "schema": { "$ref": "#/definitions/BatchGetRepairTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RepairTypes/Batch": { "post": { "tags": [ "Repair Type" ], "summary": "Create a new collection of Repair Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RepairType->PermissionTree_Id | integer | int64 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n| notes | RepairType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateRepairType", "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/BatchCreateRepairTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Repair Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Repair Type" ], "summary": "Update a collection of existing Repair Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->Version | integer | int32 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n| sequenceNumber | RepairType->SequenceNumber | integer | int32 |\r\n| notes | RepairType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateRepairType", "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/BatchUpdateRepairTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Repair Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Repair Type" ], "summary": "Delete a collection of existing Repair Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->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": "BatchDeleteRepairType", "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/BatchDeleteRepairTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Repair Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RepairTypes/{id}/Active": { "patch": { "tags": [ "Repair Type" ], "summary": "Change the IsActive status for an existing Repair Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RepairType->Version | integer | int32 |\r\n| isActive | RepairType->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": "ChangeRepairTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Repair Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRepairTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/RepairTypes/{id}/PermissionTree": { "patch": { "tags": [ "Repair Type" ], "summary": "Change the PermissionTree for an existing Repair Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RepairType->Version | integer | int32 |\r\n| permissionTreeId | RepairType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRepairTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Repair Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRepairTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/RepairTypes/Batch/Active": { "patch": { "tags": [ "Repair Type" ], "summary": "Change the IsActive status for a collection of existing Repair Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->Version | integer | int32 |\r\n| isActive | RepairType->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": "BatchChangeRepairTypeIsActive", "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/BatchChangeRepairTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/RepairTypes/Batch/PermissionTree": { "patch": { "tags": [ "Repair Type" ], "summary": "Change the PermissionTree status for a collection of existing Repair Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RepairType->Id | integer | int64 |\r\n| version | RepairType->Version | integer | int32 |\r\n| permissionTreeId | RepairType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRepairTypePermissionTree", "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/BatchChangeRepairTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/Rules/{id}": { "get": { "tags": [ "Rule" ], "summary": "Get a Rule resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Rule->Code | string | |\r\n| isActive | Rule->IsActive | boolean | |\r\n| createdByUserId | Rule->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Rule->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Rule->CreatedByUser_FullName | string | |\r\n| createdOn | Rule->CreatedOn | string | date-time |\r\n| modifiedByUserId | Rule->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Rule->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Rule->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Rule->ModifiedOn | string | date-time |\r\n| version | Rule->Version | integer | int32 |\r\n| permissionTreeId | Rule->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Rule->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Rule->PermissionTree_Description | string | |\r\n| id | Rule->Id | integer | int64 |\r\n| description | Rule->Description | string | |\r\n| notes | Rule->Notes | string | |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRule", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Rule", "schema": { "$ref": "#/definitions/GetRuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Rule" ], "summary": "Update an existing Rule resource.", "description": "### Request Body\r\n#### 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 | Rule->Version | integer | int32 |\r\n| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| notes | Rule->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| ruleText | Nullable | False | |\r\n\r\n", "operationId": "UpdateRule", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRuleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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": [ "Rule" ], "summary": "Delete an existing Rule resource.", "description": "### Request Body\r\n#### 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 | Rule->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": "DeleteRule", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRuleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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/AMPC/Rules": { "get": { "tags": [ "Rule" ], "summary": "Get a collection of Rule 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 | Rule->Id | integer | int64 |\r\n| version | Rule->Version | integer | int32 |\r\n| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| permissionTreeCode | Rule->PermissionTree_Code | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n| notes | Rule->Notes | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n| createdOn | Rule->CreatedOn | string | date-time |\r\n| modifiedOn | Rule->ModifiedOn | string | date-time |\r\n", "operationId": "GetRuleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Rule collection", "schema": { "$ref": "#/definitions/GetRuleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Rule" ], "summary": "Create a new Rule resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Rule->PermissionTree_Id | integer | int64 |\r\n| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| notes | Rule->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| ruleText | Required | True | |\r\n| ruleText | Nullable | False | |\r\n\r\n", "operationId": "CreateRule", "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/CreateRuleResourceActionRequest" } }, { "$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/AMPC/RuleCategories/{id}/Rules": { "get": { "tags": [ "Rule" ], "summary": "Get a collection of Rule resources for the Rule Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Rule->Id | integer | int64 |\r\n| version | Rule->Version | integer | int32 |\r\n| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n", "operationId": "GetRuleForRuleCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Category 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 Rule collection", "schema": { "$ref": "#/definitions/GetRuleForRuleCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Rules/Lookups/LookupRuleChangePermissionTree": { "get": { "tags": [ "Rule" ], "summary": "Lookup the permission set for changing the Rule.", "description": "### Response Body\r\n#### Payload\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": "LookupRuleChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RuleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Rules/Lookups/LookupRuleInsertPermissionTree": { "get": { "tags": [ "Rule" ], "summary": "Lookup the permission set for creating the Rule.", "description": "### Response Body\r\n#### Payload\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": "LookupRuleInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RuleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Rules/Lookups/LookupRuleRuleCategory": { "get": { "tags": [ "Rule" ], "summary": "Lookup the Rule Category for the Rule.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RuleCategory->Id | integer | int64 |\r\n| code | RuleCategory->Code | string | |\r\n| description | RuleCategory->Description | string | |\r\n", "operationId": "LookupRuleRuleCategory", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Rule Category collection", "schema": { "$ref": "#/definitions/RuleRuleCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Rules/Batch/{ids}": { "get": { "tags": [ "Rule" ], "summary": "Get a collection of Rule resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | Rule->Code | string | |\r\n| isActive | Rule->IsActive | boolean | |\r\n| createdByUserId | Rule->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Rule->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Rule->CreatedByUser_FullName | string | |\r\n| createdOn | Rule->CreatedOn | string | date-time |\r\n| modifiedByUserId | Rule->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Rule->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Rule->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Rule->ModifiedOn | string | date-time |\r\n| version | Rule->Version | integer | int32 |\r\n| permissionTreeId | Rule->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Rule->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Rule->PermissionTree_Description | string | |\r\n| id | Rule->Id | integer | int64 |\r\n| description | Rule->Description | string | |\r\n| notes | Rule->Notes | string | |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRule", "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 Rule 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 Rule collection", "schema": { "$ref": "#/definitions/BatchGetRuleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Rules/Batch": { "post": { "tags": [ "Rule" ], "summary": "Create a new collection of Rule resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | Rule->PermissionTree_Id | integer | int64 |\r\n| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| notes | Rule->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| ruleText | Required | True | |\r\n| ruleText | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRule", "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/BatchCreateRuleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Rule 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": [ "Rule" ], "summary": "Update a collection of existing Rule resources.", "description": "### Request Body\r\n#### 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 | Rule->Id | integer | int64 |\r\n| version | Rule->Version | integer | int32 |\r\n| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| sequenceNumber | Rule->SequenceNumber | integer | int32 |\r\n| ruleCategoryId | Rule->RuleCategory_Id | integer | int64 |\r\n| ruleText | Rule->RuleText | string | |\r\n| notes | Rule->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| ruleText | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRule", "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/BatchUpdateRuleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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": [ "Rule" ], "summary": "Delete a collection of existing Rule resources.", "description": "### Request Body\r\n#### 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 | Rule->Id | integer | int64 |\r\n| version | Rule->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": "BatchDeleteRule", "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/BatchDeleteRuleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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/AMPC/Rules/{id}/Active": { "patch": { "tags": [ "Rule" ], "summary": "Change the IsActive status for an existing Rule resource.", "description": "### Request Body\r\n#### 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 | Rule->Version | integer | int32 |\r\n| isActive | Rule->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": "ChangeRuleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRuleIsActiveResourceActionRequest" } }, { "$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/AMPC/Rules/{id}/PermissionTree": { "patch": { "tags": [ "Rule" ], "summary": "Change the PermissionTree for an existing Rule resource.", "description": "### Request Body\r\n#### 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 | Rule->Version | integer | int32 |\r\n| permissionTreeId | Rule->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRulePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRulePermissionTreeResourceActionRequest" } }, { "$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/AMPC/Rules/Batch/Active": { "patch": { "tags": [ "Rule" ], "summary": "Change the IsActive status for a collection of existing Rule resources.", "description": "### Request Body\r\n#### 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 | Rule->Id | integer | int64 |\r\n| version | Rule->Version | integer | int32 |\r\n| isActive | Rule->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": "BatchChangeRuleIsActive", "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/BatchChangeRuleIsActiveResourceActionRequest" } }, { "$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/AMPC/Rules/Batch/PermissionTree": { "patch": { "tags": [ "Rule" ], "summary": "Change the PermissionTree status for a collection of existing Rule resources.", "description": "### Request Body\r\n#### 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 | Rule->Id | integer | int64 |\r\n| version | Rule->Version | integer | int32 |\r\n| permissionTreeId | Rule->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRulePermissionTree", "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/BatchChangeRulePermissionTreeResourceActionRequest" } }, { "$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/AMPC/RuleCategories/{id}": { "get": { "tags": [ "Rule Category" ], "summary": "Get a Rule Category resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RuleCategory->Code | string | |\r\n| createdByUserId | RuleCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RuleCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RuleCategory->CreatedByUser_FullName | string | |\r\n| createdOn | RuleCategory->CreatedOn | string | date-time |\r\n| isActive | RuleCategory->IsActive | boolean | |\r\n| modifiedByUserId | RuleCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RuleCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RuleCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RuleCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | RuleCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RuleCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RuleCategory->PermissionTree_Description | string | |\r\n| version | RuleCategory->Version | integer | int32 |\r\n| id | RuleCategory->Id | integer | int64 |\r\n| description | RuleCategory->Description | string | |\r\n| notes | RuleCategory->Notes | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRuleCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Rule Category", "schema": { "$ref": "#/definitions/GetRuleCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Rule Category" ], "summary": "Update an existing Rule 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 | RuleCategory->Version | integer | int32 |\r\n| code | RuleCategory->Code | string | |\r\n| description | RuleCategory->Description | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n| notes | RuleCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateRuleCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRuleCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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": [ "Rule Category" ], "summary": "Delete an existing Rule 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 | RuleCategory->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": "DeleteRuleCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRuleCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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/AMPC/RuleCategories": { "get": { "tags": [ "Rule Category" ], "summary": "Get a collection of Rule 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 | RuleCategory->Id | integer | int64 |\r\n| version | RuleCategory->Version | integer | int32 |\r\n| code | RuleCategory->Code | string | |\r\n| description | RuleCategory->Description | string | |\r\n| permissionTreeCode | RuleCategory->PermissionTree_Code | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n| notes | RuleCategory->Notes | string | |\r\n| createdOn | RuleCategory->CreatedOn | string | date-time |\r\n| modifiedOn | RuleCategory->ModifiedOn | string | date-time |\r\n", "operationId": "GetRuleCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Rule Category collection", "schema": { "$ref": "#/definitions/GetRuleCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Rule Category" ], "summary": "Create a new Rule Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RuleCategory->PermissionTree_Id | integer | int64 |\r\n| code | RuleCategory->Code | string | |\r\n| description | RuleCategory->Description | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n| notes | RuleCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateRuleCategory", "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/CreateRuleCategoryResourceActionRequest" } }, { "$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/AMPC/RuleCategories/Lookups/LookupRuleCategoryChangePermissionTree": { "get": { "tags": [ "Rule Category" ], "summary": "Lookup the permission set for changing the Rule Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRuleCategoryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RuleCategoryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RuleCategories/Lookups/LookupRuleCategoryInsertPermissionTree": { "get": { "tags": [ "Rule Category" ], "summary": "Lookup the permission set for creating the Rule Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRuleCategoryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RuleCategoryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RuleCategories/Batch/{ids}": { "get": { "tags": [ "Rule Category" ], "summary": "Get a collection of Rule Category resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RuleCategory->Code | string | |\r\n| createdByUserId | RuleCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RuleCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RuleCategory->CreatedByUser_FullName | string | |\r\n| createdOn | RuleCategory->CreatedOn | string | date-time |\r\n| isActive | RuleCategory->IsActive | boolean | |\r\n| modifiedByUserId | RuleCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RuleCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RuleCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RuleCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | RuleCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RuleCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RuleCategory->PermissionTree_Description | string | |\r\n| version | RuleCategory->Version | integer | int32 |\r\n| id | RuleCategory->Id | integer | int64 |\r\n| description | RuleCategory->Description | string | |\r\n| notes | RuleCategory->Notes | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRuleCategory", "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 Rule 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 Rule Category collection", "schema": { "$ref": "#/definitions/BatchGetRuleCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RuleCategories/Batch": { "post": { "tags": [ "Rule Category" ], "summary": "Create a new collection of Rule Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RuleCategory->PermissionTree_Id | integer | int64 |\r\n| code | RuleCategory->Code | string | |\r\n| description | RuleCategory->Description | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n| notes | RuleCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateRuleCategory", "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/BatchCreateRuleCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Rule 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": [ "Rule Category" ], "summary": "Update a collection of existing Rule 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 | RuleCategory->Id | integer | int64 |\r\n| version | RuleCategory->Version | integer | int32 |\r\n| code | RuleCategory->Code | string | |\r\n| description | RuleCategory->Description | string | |\r\n| sequenceNumber | RuleCategory->SequenceNumber | integer | int32 |\r\n| notes | RuleCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateRuleCategory", "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/BatchUpdateRuleCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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": [ "Rule Category" ], "summary": "Delete a collection of existing Rule 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 | RuleCategory->Id | integer | int64 |\r\n| version | RuleCategory->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": "BatchDeleteRuleCategory", "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/BatchDeleteRuleCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Rule 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/AMPC/RuleCategories/{id}/Active": { "patch": { "tags": [ "Rule Category" ], "summary": "Change the IsActive status for an existing Rule 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 | RuleCategory->Version | integer | int32 |\r\n| isActive | RuleCategory->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": "ChangeRuleCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRuleCategoryIsActiveResourceActionRequest" } }, { "$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/AMPC/RuleCategories/{id}/PermissionTree": { "patch": { "tags": [ "Rule Category" ], "summary": "Change the PermissionTree for an existing Rule 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 | RuleCategory->Version | integer | int32 |\r\n| permissionTreeId | RuleCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRuleCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRuleCategoryPermissionTreeResourceActionRequest" } }, { "$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/AMPC/RuleCategories/Batch/Active": { "patch": { "tags": [ "Rule Category" ], "summary": "Change the IsActive status for a collection of existing Rule 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 | RuleCategory->Id | integer | int64 |\r\n| version | RuleCategory->Version | integer | int32 |\r\n| isActive | RuleCategory->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": "BatchChangeRuleCategoryIsActive", "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/BatchChangeRuleCategoryIsActiveResourceActionRequest" } }, { "$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/AMPC/RuleCategories/Batch/PermissionTree": { "patch": { "tags": [ "Rule Category" ], "summary": "Change the PermissionTree status for a collection of existing Rule 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 | RuleCategory->Id | integer | int64 |\r\n| version | RuleCategory->Version | integer | int32 |\r\n| permissionTreeId | RuleCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRuleCategoryPermissionTree", "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/BatchChangeRuleCategoryPermissionTreeResourceActionRequest" } }, { "$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/AMPC/RuleOptions/{id}": { "get": { "tags": [ "Rule Option" ], "summary": "Get a Rule 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 | RuleOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RuleOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RuleOption->CreatedByUser_FullName | string | |\r\n| createdOn | RuleOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | RuleOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RuleOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RuleOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RuleOption->ModifiedOn | string | date-time |\r\n| version | RuleOption->Version | integer | int32 |\r\n| id | RuleOption->Id | integer | int64 |\r\n| optionId | RuleOption->Option_Id | integer | int64 |\r\n| optionCode | RuleOption->Option_Code | string | |\r\n| optionDescription | RuleOption->Option_Description | string | |\r\n| optionDataType | RuleOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionOptionCategoryId | RuleOption->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | RuleOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RuleOption->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | RuleOption->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | RuleOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RuleOption->Option_UnitOfMeasurement_Description | string | |\r\n| ruleId | RuleOption->Rule_Id | integer | int64 |\r\n| ruleCode | RuleOption->Rule_Code | string | |\r\n| ruleDescription | RuleOption->Rule_Description | string | |\r\n| ruleRuleText | RuleOption->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RuleOption->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RuleOption->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RuleOption->Rule_RuleCategory_Description | string | |\r\n", "operationId": "GetRuleOption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Rule Option Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Rule Option", "schema": { "$ref": "#/definitions/GetRuleOptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RuleOptions": { "get": { "tags": [ "Rule Option" ], "summary": "Get a collection of Rule Option 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 | RuleOption->Id | integer | int64 |\r\n| version | RuleOption->Version | integer | int32 |\r\n| ruleId | RuleOption->Rule_Id | integer | int64 |\r\n| ruleCode | RuleOption->Rule_Code | string | |\r\n| ruleDescription | RuleOption->Rule_Description | string | |\r\n| ruleRuleCategoryCode | RuleOption->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RuleOption->Rule_RuleCategory_Description | string | |\r\n| optionId | RuleOption->Option_Id | integer | int64 |\r\n| optionCode | RuleOption->Option_Code | string | |\r\n| optionDescription | RuleOption->Option_Description | string | |\r\n| optionOptionCategoryCode | RuleOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RuleOption->Option_OptionCategory_Description | string | |\r\n| optionDataType | RuleOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionUnitOfMeasurementCode | RuleOption->Option_UnitOfMeasurement_Code | string | |\r\n| createdOn | RuleOption->CreatedOn | string | date-time |\r\n| modifiedOn | RuleOption->ModifiedOn | string | date-time |\r\n", "operationId": "GetRuleOptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Rule Option collection", "schema": { "$ref": "#/definitions/GetRuleOptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Rules/{ruleId}/ruleOptions": { "get": { "tags": [ "Rule Option" ], "summary": "Get a collection of Rule Options for the Rule.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RuleOption->Id | integer | int64 |\r\n| version | RuleOption->Version | integer | int32 |\r\n| optionId | RuleOption->Option_Id | integer | int64 |\r\n| optionCode | RuleOption->Option_Code | string | |\r\n| optionDescription | RuleOption->Option_Description | string | |\r\n| optionOptionCategoryCode | RuleOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RuleOption->Option_OptionCategory_Description | string | |\r\n| optionDataType | RuleOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionUnitOfMeasurementCode | RuleOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RuleOption->Option_UnitOfMeasurement_Description | string | |\r\n", "operationId": "GetRuleOptionForRuleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "ruleId", "in": "path", "required": true, "description": "Rule 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 Rule Option collection", "schema": { "$ref": "#/definitions/GetRuleOptionForRuleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RuleOptions/Batch/{ids}": { "get": { "tags": [ "Rule Option" ], "summary": "Get a collection of Rule Option 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 | RuleOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RuleOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RuleOption->CreatedByUser_FullName | string | |\r\n| createdOn | RuleOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | RuleOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RuleOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RuleOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RuleOption->ModifiedOn | string | date-time |\r\n| version | RuleOption->Version | integer | int32 |\r\n| id | RuleOption->Id | integer | int64 |\r\n| optionId | RuleOption->Option_Id | integer | int64 |\r\n| optionCode | RuleOption->Option_Code | string | |\r\n| optionDescription | RuleOption->Option_Description | string | |\r\n| optionDataType | RuleOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionOptionCategoryId | RuleOption->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | RuleOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RuleOption->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | RuleOption->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | RuleOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RuleOption->Option_UnitOfMeasurement_Description | string | |\r\n| ruleId | RuleOption->Rule_Id | integer | int64 |\r\n| ruleCode | RuleOption->Rule_Code | string | |\r\n| ruleDescription | RuleOption->Rule_Description | string | |\r\n| ruleRuleText | RuleOption->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RuleOption->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RuleOption->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RuleOption->Rule_RuleCategory_Description | string | |\r\n", "operationId": "BatchGetRuleOption", "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 Rule Option 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 Rule Option collection", "schema": { "$ref": "#/definitions/BatchGetRuleOptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{id}": { "get": { "tags": [ "Standard Task" ], "summary": "Get a 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| code | StandardTask->Code | string | |\r\n| createdByUserId | StandardTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTask->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTask->ModifiedOn | string | date-time |\r\n| version | StandardTask->Version | integer | int32 |\r\n| permissionTreeId | StandardTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTask->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTask->Id | integer | int64 |\r\n| isActive | StandardTask->IsActive | boolean | |\r\n| isBackup | StandardTask->IsBackup | boolean | |\r\n| isInherited | StandardTask->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | StandardTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | StandardTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | StandardTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | StandardTask->AutoCalculateTotalDuration | boolean | |\r\n| daysToScheduleOn | StandardTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | StandardTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | StandardTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | StandardTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | StandardTask->DefaultInterval2_Description | string | |\r\n| description | StandardTask->Description | string | |\r\n| downtimePerUnit | StandardTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | StandardTask->DurationPerUnit | string | duration |\r\n| eventId | StandardTask->Event_Id | integer | int64 |\r\n| eventCode | StandardTask->Event_Code | string | |\r\n| eventDescription | StandardTask->Event_Description | string | |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| importanceId | StandardTask->Importance_Id | integer | int64 |\r\n| importanceCode | StandardTask->Importance_Code | string | |\r\n| importanceDescription | StandardTask->Importance_Description | string | |\r\n| inheritedFromId | StandardTask->InheritedFrom_Id | integer | int64 |\r\n| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | StandardTask->IntervalType1_Code | string | |\r\n| intervalType1SchedulingKind | StandardTask->IntervalType1_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| intervalType1Description | StandardTask->IntervalType1_Description | string | |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | StandardTask->IntervalType2_Code | string | |\r\n| intervalType2Description | StandardTask->IntervalType2_Description | string | |\r\n| intervalType2SchedulingKind | StandardTask->IntervalType2_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isDualScheduling | StandardTask->IsDualScheduling | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isStatutory | StandardTask->IsStatutory | boolean | |\r\n| isSuppressed | StandardTask->IsSuppressed | boolean | |\r\n| isSuppressor | StandardTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | StandardTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | StandardTask->LongDescription | string | |\r\n| machineState | StandardTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | StandardTask->Notes | string | |\r\n| printLongDescriptionOnWorkOrder | StandardTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| recordType | StandardTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | StandardTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | StandardTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | StandardTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceResourceType | StandardTask->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | StandardTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | StandardTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | StandardTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | StandardTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | StandardTask->ResponsibleTrade_Description | string | |\r\n| schedulingMethod | StandardTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| taskClassification1Id | StandardTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | StandardTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | StandardTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | StandardTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | StandardTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | StandardTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | StandardTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | StandardTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | StandardTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | StandardTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | StandardTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | StandardTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | StandardTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | StandardTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | StandardTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | StandardTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | StandardTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | StandardTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | StandardTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | StandardTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | StandardTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | StandardTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | StandardTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | StandardTask->TaskClassification8_Description | string | |\r\n| taskRollUpPointId | StandardTask->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | StandardTask->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | StandardTask->TaskRollUpPoint_Description | string | |\r\n| totalDowntime | StandardTask->TotalDowntime | string | duration |\r\n| totalDuration | StandardTask->TotalDuration | string | duration |\r\n| typeOfWorkId | StandardTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | StandardTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | StandardTask->TypeOfWork_Description | string | |\r\n", "operationId": "GetStandardTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task", "schema": { "$ref": "#/definitions/GetStandardTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task" ], "summary": "Update an existing 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 | StandardTask->Version | integer | int32 |\r\n| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | StandardTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | StandardTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | StandardTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | StandardTask->AutoCalculateTotalDuration | boolean | |\r\n| code | StandardTask->Code | string | |\r\n| daysToScheduleOn | StandardTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| description | StandardTask->Description | string | |\r\n| downtimePerUnit | StandardTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | StandardTask->DurationPerUnit | string | duration |\r\n| eventId | StandardTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| importanceId | StandardTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | StandardTask->IsDualScheduling | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isStatutory | StandardTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | StandardTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | StandardTask->LongDescription | string | |\r\n| machineState | StandardTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | StandardTask->Notes | string | |\r\n| printLongDescriptionOnWorkOrder | StandardTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | StandardTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | StandardTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | StandardTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | StandardTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | StandardTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | StandardTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | StandardTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | StandardTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | StandardTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | StandardTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | StandardTask->TotalDowntime | string | duration |\r\n| totalDuration | StandardTask->TotalDuration | string | duration |\r\n| typeOfWorkId | StandardTask->TypeOfWork_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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| autoCalculateDowntimePerUnit | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| failedReasonRequired | Nullable | False | StandardTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Nullable | False | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| typeOfWorkId | Nullable | False | |\r\n\r\n", "operationId": "UpdateStandardTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateStandardTaskResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks": { "get": { "tags": [ "Standard Task" ], "summary": "Get a collection of 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 | StandardTask->Id | integer | int64 |\r\n| version | StandardTask->Version | integer | int32 |\r\n| code | StandardTask->Code | string | |\r\n| description | StandardTask->Description | string | |\r\n| developmentStatus | StandardTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| importanceCode | StandardTask->Importance_Code | string | |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | StandardTask->IntervalType1_Code | string | |\r\n| intervalType1Description | StandardTask->IntervalType1_Description | string | |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | StandardTask->IntervalType2_Code | string | |\r\n| intervalType2Description | StandardTask->IntervalType2_Description | string | |\r\n", "operationId": "GetStandardTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/GetStandardTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Standard Task" ], "summary": "Create a new 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| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | StandardTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | StandardTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | StandardTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | StandardTask->AutoCalculateTotalDuration | boolean | |\r\n| code | StandardTask->Code | string | |\r\n| daysToScheduleOn | StandardTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| description | StandardTask->Description | string | |\r\n| downtimePerUnit | StandardTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | StandardTask->DurationPerUnit | string | duration |\r\n| eventId | StandardTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| importanceId | StandardTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | StandardTask->IsDualScheduling | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isStatutory | StandardTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | StandardTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | StandardTask->LongDescription | string | |\r\n| machineState | StandardTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | StandardTask->Notes | string | |\r\n| permissionTreeId | StandardTask->PermissionTree_Id | integer | int64 |\r\n| printLongDescriptionOnWorkOrder | StandardTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | StandardTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | StandardTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | StandardTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | StandardTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | StandardTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | StandardTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | StandardTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | StandardTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | StandardTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | StandardTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | StandardTask->TotalDowntime | string | duration |\r\n| totalDuration | StandardTask->TotalDuration | string | duration |\r\n| typeOfWorkId | StandardTask->TypeOfWork_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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| autoCalculateDowntimePerUnit | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| failedReasonRequired | Nullable | False | StandardTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Required | True | |\r\n| importanceId | Nullable | False | |\r\n| intervalType1Id | Required | True | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| isDualScheduling | Required | True | |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Required | True | |\r\n| isInspection | Nullable | False | |\r\n| isMandatory | Required | True | |\r\n| isMandatory | Nullable | False | |\r\n| isStatutory | Required | True | |\r\n| isStatutory | Nullable | False | |\r\n| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| typeOfWorkId | Required | True | |\r\n| typeOfWorkId | Nullable | False | |\r\n\r\n", "operationId": "CreateStandardTask", "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/CreateStandardTaskResourceActionRequest" } }, { "$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/AMPC/StandardTasks/Lookups/LookupStandardTaskChangePermissionTree": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the permission set for changing the 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 | 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": "LookupStandardTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskDefaultInterval1": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Task Interval for the 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 | TaskInterval->Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n", "operationId": "LookupStandardTaskDefaultInterval1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval collection", "schema": { "$ref": "#/definitions/StandardTaskDefaultInterval1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskDefaultInterval2": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Task Interval for the 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 | TaskInterval->Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n", "operationId": "LookupStandardTaskDefaultInterval2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval collection", "schema": { "$ref": "#/definitions/StandardTaskDefaultInterval2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskEvent": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Event for the 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 | Event->Id | integer | int64 |\r\n| code | Event->Code | string | |\r\n| description | Event->Description | string | |\r\n", "operationId": "LookupStandardTaskEvent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Event collection", "schema": { "$ref": "#/definitions/StandardTaskEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskForAssetRegister": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup Standard Task for linking to AssetRegister", "description": "### Response Body\r\n#### Payload\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| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Description | StandardTask->IntervalType1_Description | string | |\r\n| intervalType2Description | StandardTask->IntervalType2_Description | string | |\r\n| developmentStatus | StandardTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "LookupStandardTaskForAssetRegister", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskForAssetRegisterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskForAssetTypeRegister": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup Standard Task for linking to AssetTypeRegister", "description": "### Response Body\r\n#### Payload\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| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Description | StandardTask->IntervalType1_Description | string | |\r\n| intervalType2Description | StandardTask->IntervalType2_Description | string | |\r\n| developmentStatus | StandardTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "LookupStandardTaskForAssetTypeRegister", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskForAssetTypeRegisterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskImportance": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Task Importance for the 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 | TaskImportance->Id | integer | int64 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n", "operationId": "LookupStandardTaskImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Importance collection", "schema": { "$ref": "#/definitions/StandardTaskImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskInsertPermissionTree": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the permission set for creating the 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 | 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": "LookupStandardTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskIntervalType1": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Task Interval Type for the 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 | TaskIntervalType->Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n", "operationId": "LookupStandardTaskIntervalType1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval Type collection", "schema": { "$ref": "#/definitions/StandardTaskIntervalType1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskIntervalType2": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Task Interval Type for the 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 | TaskIntervalType->Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n", "operationId": "LookupStandardTaskIntervalType2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval Type collection", "schema": { "$ref": "#/definitions/StandardTaskIntervalType2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskResponsibleSection": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Section for the 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 | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupStandardTaskResponsibleSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Section collection", "schema": { "$ref": "#/definitions/StandardTaskResponsibleSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskResponsibleStaffMemberResource": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Resource for the 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 | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupStandardTaskResponsibleStaffMemberResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Resource collection", "schema": { "$ref": "#/definitions/StandardTaskResponsibleStaffMemberResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskResponsibleTrade": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Trade for the 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 | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupStandardTaskResponsibleTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Trade collection", "schema": { "$ref": "#/definitions/StandardTaskResponsibleTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification1": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification2": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification3": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification3", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification4": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification4", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification5": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification5", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification6": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification6", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification6LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification7": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification7", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification7LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskClassification8": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskClassification8", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Classification Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskTaskClassification8LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTaskRollUpPoint": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Standard Task for the 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 | TaskRollUpPoint->Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n", "operationId": "LookupStandardTaskTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Roll Up Point collection", "schema": { "$ref": "#/definitions/StandardTaskTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Lookups/LookupStandardTaskTypeOfWork": { "get": { "tags": [ "Standard Task" ], "summary": "Lookup the Type of Work for the 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 | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n", "operationId": "LookupStandardTaskTypeOfWork", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Batch/{ids}": { "get": { "tags": [ "Standard Task" ], "summary": "Get a collection of 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| code | StandardTask->Code | string | |\r\n| createdByUserId | StandardTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTask->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTask->ModifiedOn | string | date-time |\r\n| version | StandardTask->Version | integer | int32 |\r\n| permissionTreeId | StandardTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTask->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTask->Id | integer | int64 |\r\n| isActive | StandardTask->IsActive | boolean | |\r\n| isBackup | StandardTask->IsBackup | boolean | |\r\n| isInherited | StandardTask->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | StandardTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | StandardTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | StandardTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | StandardTask->AutoCalculateTotalDuration | boolean | |\r\n| daysToScheduleOn | StandardTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | StandardTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | StandardTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | StandardTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | StandardTask->DefaultInterval2_Description | string | |\r\n| description | StandardTask->Description | string | |\r\n| downtimePerUnit | StandardTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | StandardTask->DurationPerUnit | string | duration |\r\n| eventId | StandardTask->Event_Id | integer | int64 |\r\n| eventCode | StandardTask->Event_Code | string | |\r\n| eventDescription | StandardTask->Event_Description | string | |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| importanceId | StandardTask->Importance_Id | integer | int64 |\r\n| importanceCode | StandardTask->Importance_Code | string | |\r\n| importanceDescription | StandardTask->Importance_Description | string | |\r\n| inheritedFromId | StandardTask->InheritedFrom_Id | integer | int64 |\r\n| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | StandardTask->IntervalType1_Code | string | |\r\n| intervalType1SchedulingKind | StandardTask->IntervalType1_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| intervalType1Description | StandardTask->IntervalType1_Description | string | |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | StandardTask->IntervalType2_Code | string | |\r\n| intervalType2Description | StandardTask->IntervalType2_Description | string | |\r\n| intervalType2SchedulingKind | StandardTask->IntervalType2_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isDualScheduling | StandardTask->IsDualScheduling | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isStatutory | StandardTask->IsStatutory | boolean | |\r\n| isSuppressed | StandardTask->IsSuppressed | boolean | |\r\n| isSuppressor | StandardTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | StandardTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | StandardTask->LongDescription | string | |\r\n| machineState | StandardTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | StandardTask->Notes | string | |\r\n| printLongDescriptionOnWorkOrder | StandardTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| recordType | StandardTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | StandardTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | StandardTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | StandardTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceResourceType | StandardTask->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | StandardTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | StandardTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | StandardTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | StandardTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | StandardTask->ResponsibleTrade_Description | string | |\r\n| schedulingMethod | StandardTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| taskClassification1Id | StandardTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | StandardTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | StandardTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | StandardTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | StandardTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | StandardTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | StandardTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | StandardTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | StandardTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | StandardTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | StandardTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | StandardTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | StandardTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | StandardTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | StandardTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | StandardTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | StandardTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | StandardTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | StandardTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | StandardTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | StandardTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | StandardTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | StandardTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | StandardTask->TaskClassification8_Description | string | |\r\n| taskRollUpPointId | StandardTask->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | StandardTask->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | StandardTask->TaskRollUpPoint_Description | string | |\r\n| totalDowntime | StandardTask->TotalDowntime | string | duration |\r\n| totalDuration | StandardTask->TotalDuration | string | duration |\r\n| typeOfWorkId | StandardTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | StandardTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | StandardTask->TypeOfWork_Description | string | |\r\n", "operationId": "BatchGetStandardTask", "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 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 Standard Task collection", "schema": { "$ref": "#/definitions/BatchGetStandardTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Batch": { "post": { "tags": [ "Standard Task" ], "summary": "Create a new collection of 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| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | StandardTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | StandardTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | StandardTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | StandardTask->AutoCalculateTotalDuration | boolean | |\r\n| code | StandardTask->Code | string | |\r\n| daysToScheduleOn | StandardTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| description | StandardTask->Description | string | |\r\n| downtimePerUnit | StandardTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | StandardTask->DurationPerUnit | string | duration |\r\n| eventId | StandardTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| importanceId | StandardTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | StandardTask->IsDualScheduling | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isStatutory | StandardTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | StandardTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | StandardTask->LongDescription | string | |\r\n| machineState | StandardTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | StandardTask->Notes | string | |\r\n| permissionTreeId | StandardTask->PermissionTree_Id | integer | int64 |\r\n| printLongDescriptionOnWorkOrder | StandardTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | StandardTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | StandardTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | StandardTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | StandardTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | StandardTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | StandardTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | StandardTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | StandardTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | StandardTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | StandardTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | StandardTask->TotalDowntime | string | duration |\r\n| totalDuration | StandardTask->TotalDuration | string | duration |\r\n| typeOfWorkId | StandardTask->TypeOfWork_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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| autoCalculateDowntimePerUnit | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| failedReasonRequired | Nullable | False | StandardTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Required | True | |\r\n| importanceId | Nullable | False | |\r\n| intervalType1Id | Required | True | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| isDualScheduling | Required | True | |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Required | True | |\r\n| isInspection | Nullable | False | |\r\n| isMandatory | Required | True | |\r\n| isMandatory | Nullable | False | |\r\n| isStatutory | Required | True | |\r\n| isStatutory | Nullable | False | |\r\n| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| typeOfWorkId | Required | True | |\r\n| typeOfWorkId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStandardTask", "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/BatchCreateStandardTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - 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" } } }, "patch": { "tags": [ "Standard Task" ], "summary": "Update a collection of existing 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 | StandardTask->Id | integer | int64 |\r\n| version | StandardTask->Version | integer | int32 |\r\n| alternativeDescription | StandardTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | StandardTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | StandardTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | StandardTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | StandardTask->AutoCalculateTotalDuration | boolean | |\r\n| code | StandardTask->Code | string | |\r\n| daysToScheduleOn | StandardTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | StandardTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | StandardTask->DefaultInterval2_Id | integer | int64 |\r\n| description | StandardTask->Description | string | |\r\n| downtimePerUnit | StandardTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | StandardTask->DurationPerUnit | string | duration |\r\n| eventId | StandardTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | StandardTask->FailedReasonRequired | boolean | |\r\n| importanceId | StandardTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | StandardTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | StandardTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | StandardTask->IsDualScheduling | boolean | |\r\n| isInspection | StandardTask->IsInspection | boolean | |\r\n| inspectionType | StandardTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | StandardTask->IsMandatory | boolean | |\r\n| isStatutory | StandardTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | StandardTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | StandardTask->LongDescription | string | |\r\n| machineState | StandardTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| motionType | StandardTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | StandardTask->Notes | string | |\r\n| printLongDescriptionOnWorkOrder | StandardTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | StandardTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | StandardTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | StandardTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | StandardTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | StandardTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | StandardTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | StandardTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | StandardTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | StandardTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | StandardTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | StandardTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | StandardTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | StandardTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | StandardTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | StandardTask->TotalDowntime | string | duration |\r\n| totalDuration | StandardTask->TotalDuration | string | duration |\r\n| typeOfWorkId | StandardTask->TypeOfWork_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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| autoCalculateDowntimePerUnit | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| failedReasonRequired | Nullable | False | StandardTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | StandardTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | StandardTask->IsDualScheduling eq false |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Nullable | False | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| typeOfWorkId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateStandardTask", "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/BatchUpdateStandardTaskResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task" ], "summary": "Accept the Development Status for an existing Standard Task resource.", "description": "", "operationId": "AcceptStandardTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task" ], "summary": "Accept the Development Status for the collection of existing Standard Task resource id's.", "description": "", "operationId": "BatchAcceptStandardTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task" ], "summary": "Change the Development Status for the collection of existing Standard Task resource id's.", "description": "", "operationId": "BatchChangeStandardTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task" ], "summary": "Reject the Development Status for the collection of existing Standard Task resource id's.", "description": "", "operationId": "BatchRejectStandardTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task" ], "summary": "Change the Development Status for an existing Standard Task resource.", "description": "", "operationId": "ChangeStandardTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{id}/Active": { "patch": { "tags": [ "Standard Task" ], "summary": "Change the IsActive status for an existing 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 | StandardTask->Version | integer | int32 |\r\n| isActive | StandardTask->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": "ChangeStandardTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskIsActiveResourceActionRequest" } }, { "$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/AMPC/StandardTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task" ], "summary": "Reject the Development Status for an existing Standard Task resource.", "description": "", "operationId": "RejectStandardTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Batch/Active": { "patch": { "tags": [ "Standard Task" ], "summary": "Change the IsActive status for a collection of existing 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 | StandardTask->Id | integer | int64 |\r\n| version | StandardTask->Version | integer | int32 |\r\n| isActive | StandardTask->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": "BatchChangeStandardTaskIsActive", "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/BatchChangeStandardTaskIsActiveResourceActionRequest" } }, { "$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/AMPC/StandardTasks/Resources/{id}": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Get a Standard Task Resource resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | StandardTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskResource->ModifiedOn | string | date-time |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskResource->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTaskResource->Id | integer | int64 |\r\n| isActive | StandardTaskResource->IsActive | boolean | |\r\n| isBackup | StandardTaskResource->IsBackup | boolean | |\r\n| isInherited | StandardTaskResource->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskResource->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskResource->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskResource->SequenceNumber | integer | int32 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | StandardTaskResource->Competency_Code | string | |\r\n| competencyDescription | StandardTaskResource->Competency_Description | string | |\r\n| competencyValidityType | StandardTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | StandardTaskResource->InheritedFrom_Id | integer | int64 |\r\n| notes | StandardTaskResource->Notes | string | |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| recordType | StandardTaskResource->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | StandardTaskResource->Resource_Code | string | |\r\n| resourceResourceType | StandardTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceContactDetailId | StandardTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | StandardTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | StandardTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | StandardTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | StandardTaskResource->Section_Code | string | |\r\n| sectionDescription | StandardTaskResource->Section_Description | string | |\r\n| standardTaskId | StandardTaskResource->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskResource->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskResource->StandardTask_Description | string | |\r\n| standardTaskLastConfirmedOn | StandardTaskResource->StandardTask_LastConfirmedOn | string | date-time |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | StandardTaskResource->Trade_Code | string | |\r\n| tradeDescription | StandardTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | StandardTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StandardTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StandardTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | StandardTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n", "operationId": "GetStandardTaskResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Resource", "schema": { "$ref": "#/definitions/GetStandardTaskResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Resource" ], "summary": "Update an existing Standard Task Resource resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| sequenceNumber | StandardTaskResource->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskResource->Notes | string | |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | StandardTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| resourceId | Nullable | False | StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL |\r\n| proficiency | Nullable | False | StandardTaskResource->Competency_Id ne NULL |\r\n| usage | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateStandardTaskResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateStandardTaskResourceResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Resource was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{id}/Resource": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Get a collection of Standard Task Resource resources for the 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 | StandardTaskResource->Id | integer | int64 |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | StandardTaskResource->Competency_Code | string | |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | StandardTaskResource->Trade_Code | string | |\r\n| tradeDescription | StandardTaskResource->Trade_Description | string | |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | StandardTaskResource->Section_Code | string | |\r\n| sectionDescription | StandardTaskResource->Section_Description | string | |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | StandardTaskResource->Resource_Code | string | |\r\n| resourceResourceType | StandardTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceContactDetailFirstName | StandardTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | StandardTaskResource->Resource_ContactDetailLastName | string | |\r\n| standardTaskId | StandardTaskResource->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskResource->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskResource->StandardTask_Description | string | |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| developmentStatus | StandardTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetStandardTaskResourceForStandardTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard 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 Standard Task Resource collection", "schema": { "$ref": "#/definitions/GetResourceForStandardTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Get a collection of Standard Task Resource resources for the 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 | StandardTaskResource->Id | integer | int64 |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | StandardTaskResource->Competency_Code | string | |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | StandardTaskResource->Trade_Code | string | |\r\n| tradeDescription | StandardTaskResource->Trade_Description | string | |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | StandardTaskResource->Section_Code | string | |\r\n| sectionDescription | StandardTaskResource->Section_Description | string | |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | StandardTaskResource->Resource_Code | string | |\r\n| resourceResourceType | StandardTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceContactDetailFirstName | StandardTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | StandardTaskResource->Resource_ContactDetailLastName | string | |\r\n| standardTaskId | StandardTaskResource->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskResource->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskResource->StandardTask_Description | string | |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n| resourceType | StandardTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| developmentStatus | StandardTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetStandardTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Resource collection", "schema": { "$ref": "#/definitions/GetStandardTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Standard Task Resource" ], "summary": "Create a new Standard Task Resource resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskResource->StandardTask_Id | integer | int64 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n| notes | StandardTaskResource->Notes | string | |\r\n| permissionTreeId | StandardTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | StandardTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | StandardTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| standardTaskId | Min Value | > 0| |\r\n| usage | System Generated | true | If no value specified |\r\n| usage | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| proficiency | Nullable | False | StandardTaskResource->Competency_Id ne NULL |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| resourceId | Nullable | False | StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL |\r\n| resourceType | System Generated | true | If no value specified |\r\n| tradeId | Required | True | |\r\n| tradeId | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "CreateStandardTaskResource", "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/CreateStandardTaskResourceResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$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/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceChangePermissionTree": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the permission set for changing the 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| 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": "LookupStandardTaskResourceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceCompetency": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the Standard Task Resource for the 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| id | Competency->Id | integer | int64 |\r\n| code | Competency->Code | string | |\r\n| description | Competency->Description | string | |\r\n", "operationId": "LookupStandardTaskResourceCompetency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Competency collection", "schema": { "$ref": "#/definitions/StandardTaskResourceCompetencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceInsertPermissionTree": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the permission set for creating the 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| 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": "LookupStandardTaskResourceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceResource": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the Standard Task Resource for the 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| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n| resourceType | Resource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n", "operationId": "LookupStandardTaskResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Resource collection", "schema": { "$ref": "#/definitions/StandardTaskResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceSection": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the Standard Task Resource for the 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| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupStandardTaskResourceSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Section collection", "schema": { "$ref": "#/definitions/StandardTaskResourceSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceStandardTask": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the Standard Task Resource for the 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| id | StandardTask->Id | integer | int64 |\r\n| code | StandardTask->Code | string | |\r\n| description | StandardTask->Description | string | |\r\n", "operationId": "LookupStandardTaskResourceStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskResourceStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the for the 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| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "LookupStandardTaskResourceTradeFinancialRateUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/StandardTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceTrade": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the Standard Task Resource for the 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| id | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupStandardTaskResourceTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Trade collection", "schema": { "$ref": "#/definitions/StandardTaskResourceTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Lookups/LookupStandardTaskResourceUnitOfMeasurement": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Lookup the for the 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| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n", "operationId": "LookupStandardTaskResourceUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/StandardTaskResourceUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Batch/{ids}": { "get": { "tags": [ "Standard Task Resource" ], "summary": "Get a collection of Standard Task Resource resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | StandardTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskResource->ModifiedOn | string | date-time |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskResource->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTaskResource->Id | integer | int64 |\r\n| isActive | StandardTaskResource->IsActive | boolean | |\r\n| isBackup | StandardTaskResource->IsBackup | boolean | |\r\n| isInherited | StandardTaskResource->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskResource->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskResource->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskResource->SequenceNumber | integer | int32 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | StandardTaskResource->Competency_Code | string | |\r\n| competencyDescription | StandardTaskResource->Competency_Description | string | |\r\n| competencyValidityType | StandardTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | StandardTaskResource->InheritedFrom_Id | integer | int64 |\r\n| notes | StandardTaskResource->Notes | string | |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| recordType | StandardTaskResource->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | StandardTaskResource->Resource_Code | string | |\r\n| resourceResourceType | StandardTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceContactDetailId | StandardTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | StandardTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | StandardTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | StandardTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | StandardTaskResource->Section_Code | string | |\r\n| sectionDescription | StandardTaskResource->Section_Description | string | |\r\n| standardTaskId | StandardTaskResource->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskResource->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskResource->StandardTask_Description | string | |\r\n| standardTaskLastConfirmedOn | StandardTaskResource->StandardTask_LastConfirmedOn | string | date-time |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | StandardTaskResource->Trade_Code | string | |\r\n| tradeDescription | StandardTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | StandardTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | StandardTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | StandardTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | StandardTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n", "operationId": "BatchGetStandardTaskResource", "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 Standard Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Resource collection", "schema": { "$ref": "#/definitions/BatchGetStandardTaskResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Batch": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Create a new collection of Standard Task Resource resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskResource->StandardTask_Id | integer | int64 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n| notes | StandardTaskResource->Notes | string | |\r\n| permissionTreeId | StandardTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | StandardTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | StandardTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| standardTaskId | Min Value | > 0| |\r\n| usage | System Generated | true | If no value specified |\r\n| usage | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| proficiency | Nullable | False | StandardTaskResource->Competency_Id ne NULL |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| resourceId | Nullable | False | StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL |\r\n| resourceType | System Generated | true | If no value specified |\r\n| tradeId | Required | True | |\r\n| tradeId | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStandardTaskResource", "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/BatchCreateStandardTaskResourceResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Standard Task Resource batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Resource" ], "summary": "Update a collection of existing Standard Task Resource resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskResource->Id | integer | int64 |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| sequenceNumber | StandardTaskResource->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskResource->Notes | string | |\r\n| sectionId | StandardTaskResource->Section_Id | integer | int64 |\r\n| tradeId | StandardTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | StandardTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | StandardTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | StandardTaskResource->Proficiency | integer | int32 |\r\n| usage | StandardTaskResource->Usage | object | composite |\r\n| quantity | StandardTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | StandardTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| resourceId | Nullable | False | StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL |\r\n| proficiency | Nullable | False | StandardTaskResource->Competency_Id ne NULL |\r\n| usage | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateStandardTaskResource", "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/BatchUpdateStandardTaskResourceResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Resource batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Accept the Development Status for an existing Standard Task Resource resource.", "description": "", "operationId": "AcceptStandardTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Accept the Development Status for the collection of existing Standard Task Resource resource id's.", "description": "", "operationId": "BatchAcceptStandardTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Change the Development Status for the collection of existing Standard Task Resource resource id's.", "description": "", "operationId": "BatchChangeStandardTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Reject the Development Status for the collection of existing Standard Task Resource resource id's.", "description": "", "operationId": "BatchRejectStandardTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Change the Development Status for an existing Standard Task Resource resource.", "description": "", "operationId": "ChangeStandardTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{id}/Active": { "patch": { "tags": [ "Standard Task Resource" ], "summary": "Change the IsActive status for an existing Standard Task Resource resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| isActive | StandardTaskResource->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": "ChangeStandardTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskResourceIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Resource" ], "summary": "Reject the Development Status for an existing Standard Task Resource resource.", "description": "", "operationId": "RejectStandardTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Resources/Batch/Active": { "patch": { "tags": [ "Standard Task Resource" ], "summary": "Change the IsActive status for a collection of existing Standard Task Resource resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskResource->Id | integer | int64 |\r\n| version | StandardTaskResource->Version | integer | int32 |\r\n| isActive | StandardTaskResource->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": "BatchChangeStandardTaskResourceIsActive", "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/BatchChangeStandardTaskResourceIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{id}": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Get a Standard Task Spare resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | StandardTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskSpare->ModifiedOn | string | date-time |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskSpare->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTaskSpare->Id | integer | int64 |\r\n| isActive | StandardTaskSpare->IsActive | boolean | |\r\n| isBackup | StandardTaskSpare->IsBackup | boolean | |\r\n| isInherited | StandardTaskSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskSpare->SequenceNumber | integer | int32 |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | StandardTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | StandardTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | StandardTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| materialMasterId | StandardTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StandardTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StandardTaskSpare->MaterialMaster_Description | string | |\r\n| notes | StandardTaskSpare->Notes | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| recordType | StandardTaskSpare->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| standardTaskId | StandardTaskSpare->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskSpare->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskSpare->StandardTask_Description | string | |\r\n", "operationId": "GetStandardTaskSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Spare", "schema": { "$ref": "#/definitions/GetStandardTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Spare" ], "summary": "Update an existing Standard Task Spare resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | StandardTaskSpare->Notes | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | StandardTaskSpare->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateStandardTaskSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateStandardTaskSpareResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Spare was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{id}/Spares": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Get a collection of Standard Task Spare resources for the 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 | StandardTaskSpare->Id | integer | int64 |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| materialMasterId | StandardTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StandardTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StandardTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | StandardTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StandardTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StandardTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | StandardTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | StandardTaskSpare->CostElement_Description | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetStandardTaskSpareForStandardTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard 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 Standard Task Spare collection", "schema": { "$ref": "#/definitions/GetSpareForStandardTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Get a collection of Standard Task Spare resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskSpare->Id | integer | int64 |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| materialMasterId | StandardTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StandardTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StandardTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | StandardTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StandardTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StandardTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | StandardTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | StandardTaskSpare->CostElement_Description | string | |\r\n| standardTaskId | StandardTaskSpare->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskSpare->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskSpare->StandardTask_Description | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| developmentStatus | StandardTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetStandardTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Spare collection", "schema": { "$ref": "#/definitions/GetStandardTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Standard Task Spare" ], "summary": "Create a new Standard Task Spare resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskSpare->StandardTask_Id | integer | int64 |\r\n| materialMasterId | StandardTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | StandardTaskSpare->Notes | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | StandardTaskSpare->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| standardTaskId | Min Value | > 0| |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "CreateStandardTaskSpare", "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/CreateStandardTaskSpareResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$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/AMPC/StandardTasks/Spares/Lookups/LookupStandardTaskSpareChangePermissionTree": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Lookup the permission set for changing the Standard Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Lookups/LookupStandardTaskSpareCommodity": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Lookup the Commodity for the Standard Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Commodity->Id | integer | int64 |\r\n| code | Commodity->Code | string | |\r\n| description | Commodity->Description | string | |\r\n", "operationId": "LookupStandardTaskSpareCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Commodity collection", "schema": { "$ref": "#/definitions/StandardTaskSpareCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Lookups/LookupStandardTaskSpareCostElement": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Lookup the Cost Element for the Standard Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupStandardTaskSpareCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Element collection", "schema": { "$ref": "#/definitions/StandardTaskSpareCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Lookups/LookupStandardTaskSpareInsertPermissionTree": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Lookup the permission set for creating the Standard Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Lookups/LookupStandardTaskSpareMaterialMaster": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Lookup the Material Master for the Standard Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MaterialMaster->Id | integer | int64 |\r\n| code | MaterialMaster->Code | string | |\r\n| description | MaterialMaster->Description | string | |\r\n", "operationId": "LookupStandardTaskSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Material Master collection", "schema": { "$ref": "#/definitions/StandardTaskSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Lookups/LookupStandardTaskSpareStandardTask": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Lookup the Standard Task Spare for the Standard Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTask->Id | integer | int64 |\r\n| code | StandardTask->Code | string | |\r\n| description | StandardTask->Description | string | |\r\n", "operationId": "LookupStandardTaskSpareStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskSpareTaskStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Batch/{ids}": { "get": { "tags": [ "Standard Task Spare" ], "summary": "Get a collection of Standard Task Spare resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | StandardTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskSpare->ModifiedOn | string | date-time |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskSpare->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTaskSpare->Id | integer | int64 |\r\n| isActive | StandardTaskSpare->IsActive | boolean | |\r\n| isBackup | StandardTaskSpare->IsBackup | boolean | |\r\n| isInherited | StandardTaskSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskSpare->SequenceNumber | integer | int32 |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | StandardTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | StandardTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | StandardTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| materialMasterId | StandardTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StandardTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StandardTaskSpare->MaterialMaster_Description | string | |\r\n| notes | StandardTaskSpare->Notes | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| recordType | StandardTaskSpare->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| standardTaskId | StandardTaskSpare->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskSpare->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskSpare->StandardTask_Description | string | |\r\n", "operationId": "BatchGetStandardTaskSpare", "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 Standard Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Spare collection", "schema": { "$ref": "#/definitions/BatchGetStandardTaskSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Batch": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Create a new collection of Standard Task Spare resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskSpare->StandardTask_Id | integer | int64 |\r\n| materialMasterId | StandardTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | StandardTaskSpare->Notes | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | StandardTaskSpare->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| standardTaskId | Min Value | > 0| |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateStandardTaskSpare", "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/BatchCreateStandardTaskSpareResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Standard Task Spare batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Spare" ], "summary": "Update a collection of existing Standard Task Spare resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskSpare->Id | integer | int64 |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| costElementId | StandardTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | StandardTaskSpare->Notes | string | |\r\n| quantity | StandardTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | StandardTaskSpare->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateStandardTaskSpare", "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/BatchUpdateStandardTaskSpareResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Spare batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Accept the Development Status for an existing Standard Task Spare resource.", "description": "", "operationId": "AcceptStandardTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Accept the Development Status for the collection of existing Standard Task Spare resource id's.", "description": "", "operationId": "BatchAcceptStandardTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Change the Development Status for the collection of existing Standard Task Spare resource id's.", "description": "", "operationId": "BatchChangeStandardTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Reject the Development Status for the collection of existing Standard Task Spare resource id's.", "description": "", "operationId": "BatchRejectStandardTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Change the Development Status for an existing Standard Task Spare resource.", "description": "", "operationId": "ChangeStandardTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{id}/Active": { "patch": { "tags": [ "Standard Task Spare" ], "summary": "Change the IsActive status for an existing Standard Task Spare resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| isActive | StandardTaskSpare->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": "ChangeStandardTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskSpareIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Spare" ], "summary": "Reject the Development Status for an existing Standard Task Spare resource.", "description": "", "operationId": "RejectStandardTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Spares/Batch/Active": { "patch": { "tags": [ "Standard Task Spare" ], "summary": "Change the IsActive status for a collection of existing Standard Task Spare resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskSpare->Id | integer | int64 |\r\n| version | StandardTaskSpare->Version | integer | int32 |\r\n| isActive | StandardTaskSpare->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": "BatchChangeStandardTaskSpareIsActive", "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/BatchChangeStandardTaskSpareIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{id}": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Get a Standard Task Sub Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | StandardTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskSubTask->ModifiedOn | string | date-time |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskSubTask->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTaskSubTask->Id | integer | int64 |\r\n| isActive | StandardTaskSubTask->IsActive | boolean | |\r\n| isBackup | StandardTaskSubTask->IsBackup | boolean | |\r\n| isInherited | StandardTaskSubTask->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskSubTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskSubTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| inheritedFromId | StandardTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| notes | StandardTaskSubTask->Notes | string | |\r\n| recordType | StandardTaskSubTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| standardTaskId | StandardTaskSubTask->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskSubTask->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskSubTask->StandardTask_Description | string | |\r\n", "operationId": "GetStandardTaskSubTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Sub Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Sub Task", "schema": { "$ref": "#/definitions/GetStandardTaskSubTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Sub Task" ], "summary": "Update an existing Standard Task Sub Task resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| notes | StandardTaskSubTask->Notes | string | |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateStandardTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateStandardTaskSubTaskResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Sub Task was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Get a collection of Standard Task Sub Task resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskSubTask->Id | integer | int64 |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| standardTaskId | StandardTaskSubTask->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskSubTask->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskSubTask->StandardTask_Description | string | |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| developmentStatus | StandardTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n", "operationId": "GetStandardTaskSubTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Sub Task collection", "schema": { "$ref": "#/definitions/GetStandardTaskSubTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Create a new Standard Task Sub Task resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskSubTask->StandardTask_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| notes | StandardTaskSubTask->Notes | string | |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| standardTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| alternativeDescription | Required | True | |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "CreateStandardTaskSubTask", "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/CreateStandardTaskSubTaskResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$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/AMPC/StandardTasks/{id}/SubTasks": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Get a collection of Standard Task Sub Task resources for the 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 | StandardTaskSubTask->Id | integer | int64 |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n", "operationId": "GetStandardTaskSubTaskForStandardTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard 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 Standard Task Sub Task collection", "schema": { "$ref": "#/definitions/GetSubTaskForStandardTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/Lookups/LookupStandardTaskSubTaskChangePermissionTree": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Lookup the permission set for changing the Standard Task Sub Task.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskSubTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskSubTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/Lookups/LookupStandardTaskSubTaskInsertPermissionTree": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Lookup the permission set for creating the Standard Task Sub Task.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskSubTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskSubTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/Lookups/LookupStandardTaskSubTaskStandardTask": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Lookup the Standard Task Sub Task for the Standard Task Sub 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": "LookupStandardTaskSubTaskStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskSubTaskTaskStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/Batch/{ids}": { "get": { "tags": [ "Standard Task Sub Task" ], "summary": "Get a collection of Standard Task Sub Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | StandardTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskSubTask->ModifiedOn | string | date-time |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskSubTask->PermissionTree_Description | string | |\r\n| developmentStatus | StandardTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | StandardTaskSubTask->Id | integer | int64 |\r\n| isActive | StandardTaskSubTask->IsActive | boolean | |\r\n| isBackup | StandardTaskSubTask->IsBackup | boolean | |\r\n| isInherited | StandardTaskSubTask->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskSubTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskSubTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| inheritedFromId | StandardTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| notes | StandardTaskSubTask->Notes | string | |\r\n| recordType | StandardTaskSubTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| standardTaskId | StandardTaskSubTask->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskSubTask->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskSubTask->StandardTask_Description | string | |\r\n", "operationId": "BatchGetStandardTaskSubTask", "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 Standard Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Sub Task collection", "schema": { "$ref": "#/definitions/BatchGetStandardTaskSubTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/Batch": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Create a new collection of Standard Task Sub Task resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskSubTask->StandardTask_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| notes | StandardTaskSubTask->Notes | string | |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| standardTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| alternativeDescription | Required | True | |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchCreateStandardTaskSubTask", "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/BatchCreateStandardTaskSubTaskResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Standard Task Sub Task batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Sub Task" ], "summary": "Update a collection of existing Standard Task Sub Task resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskSubTask->Id | integer | int64 |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| code | StandardTaskSubTask->Code | string | |\r\n| description | StandardTaskSubTask->Description | string | |\r\n| alternativeDescription | StandardTaskSubTask->AlternativeDescription | string | |\r\n| notes | StandardTaskSubTask->Notes | string | |\r\n| sequenceNumber | StandardTaskSubTask->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| id | Min Value | >= 0| |\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 | <= 255 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateStandardTaskSubTask", "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/BatchUpdateStandardTaskSubTaskResourceActionRequest" } }, { "type": "boolean", "name": "inheritToDescendants", "in": "query", "description": "Inherit the changes to all descendants (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Sub Task batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Accept the Development Status for an existing Standard Task Sub Task resource.", "description": "", "operationId": "AcceptStandardTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Accept the Development Status for the collection of existing Standard Task Sub Task resource id's.", "description": "", "operationId": "BatchAcceptStandardTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Change the Development Status for the collection of existing Standard Task Sub Task resource id's.", "description": "", "operationId": "BatchChangeStandardTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Reject the Development Status for the collection of existing Standard Task Sub Task resource id's.", "description": "", "operationId": "BatchRejectStandardTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Change the Development Status for an existing Standard Task Sub Task resource.", "description": "", "operationId": "ChangeStandardTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "developmentStatusAction", "in": "path", "required": true, "description": "Allowed values:[UnderDevelopment, AwaitingConfirmation, DeletedAwaitingConfirmation]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "AssetTypeDevelopmentStatusChangeAction" }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{id}/Active": { "patch": { "tags": [ "Standard Task Sub Task" ], "summary": "Change the IsActive status for an existing Standard Task Sub Task resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| isActive | StandardTaskSubTask->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": "ChangeStandardTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskSubTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Sub Task" ], "summary": "Reject the Development Status for an existing Standard Task Sub Task resource.", "description": "", "operationId": "RejectStandardTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the development status operation (default=True)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/SubTasks/Batch/Active": { "patch": { "tags": [ "Standard Task Sub Task" ], "summary": "Change the IsActive status for a collection of existing Standard Task Sub Task resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskSubTask->Id | integer | int64 |\r\n| version | StandardTaskSubTask->Version | integer | int32 |\r\n| isActive | StandardTaskSubTask->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| id | Min Value | >= 0| |\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": "BatchChangeStandardTaskSubTaskIsActive", "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/BatchChangeStandardTaskSubTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskImportances/{id}": { "get": { "tags": [ "Task Importance" ], "summary": "Get a Task Importance resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskImportance->Code | string | |\r\n| createdByUserId | TaskImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskImportance->CreatedByUser_FullName | string | |\r\n| createdOn | TaskImportance->CreatedOn | string | date-time |\r\n| isActive | TaskImportance->IsActive | boolean | |\r\n| modifiedByUserId | TaskImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskImportance->ModifiedOn | string | date-time |\r\n| permissionTreeId | TaskImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskImportance->PermissionTree_Description | string | |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| description | TaskImportance->Description | string | |\r\n| notes | TaskImportance->Notes | string | |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n", "operationId": "GetTaskImportance", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Importance Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Importance", "schema": { "$ref": "#/definitions/GetTaskImportanceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Importance" ], "summary": "Update an existing Task Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| notes | TaskImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Nullable | False | |\r\n\r\n", "operationId": "UpdateTaskImportance", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTaskImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Importance was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Task Importance" ], "summary": "Delete an existing Task Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskImportance->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": "DeleteTaskImportance", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Importance Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTaskImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Importance was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskImportances": { "get": { "tags": [ "Task Importance" ], "summary": "Get a collection of Task Importance resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n| notes | TaskImportance->Notes | string | |\r\n| createdOn | TaskImportance->CreatedOn | string | date-time |\r\n| modifiedOn | TaskImportance->ModifiedOn | string | date-time |\r\n", "operationId": "GetTaskImportanceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Importance collection", "schema": { "$ref": "#/definitions/GetTaskImportanceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Task Importance" ], "summary": "Create a new Task Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskImportance->PermissionTree_Id | integer | int64 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| notes | TaskImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Required | True | |\r\n| weight | Nullable | False | |\r\n\r\n", "operationId": "CreateTaskImportance", "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/CreateTaskImportanceResourceActionRequest" } }, { "$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/AMPC/TaskImportances/Lookups/LookupTaskImportanceChangePermissionTree": { "get": { "tags": [ "Task Importance" ], "summary": "Lookup the permission set for changing the Task Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupTaskImportanceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskImportanceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskImportances/Lookups/LookupTaskImportanceInsertPermissionTree": { "get": { "tags": [ "Task Importance" ], "summary": "Lookup the permission set for creating the Task Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupTaskImportanceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskImportanceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskImportances/Batch/{ids}": { "get": { "tags": [ "Task Importance" ], "summary": "Get a collection of Task Importance resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskImportance->Code | string | |\r\n| createdByUserId | TaskImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskImportance->CreatedByUser_FullName | string | |\r\n| createdOn | TaskImportance->CreatedOn | string | date-time |\r\n| isActive | TaskImportance->IsActive | boolean | |\r\n| modifiedByUserId | TaskImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskImportance->ModifiedOn | string | date-time |\r\n| permissionTreeId | TaskImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskImportance->PermissionTree_Description | string | |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| description | TaskImportance->Description | string | |\r\n| notes | TaskImportance->Notes | string | |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetTaskImportance", "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 Task Importance id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Importance collection", "schema": { "$ref": "#/definitions/BatchGetTaskImportanceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskImportances/Batch": { "post": { "tags": [ "Task Importance" ], "summary": "Create a new collection of Task Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskImportance->PermissionTree_Id | integer | int64 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| notes | TaskImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Required | True | |\r\n| weight | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTaskImportance", "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/BatchCreateTaskImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Task Importance batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Importance" ], "summary": "Update a collection of existing Task Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n| sequenceNumber | TaskImportance->SequenceNumber | integer | int32 |\r\n| weight | TaskImportance->Weight | integer | int32 |\r\n| notes | TaskImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateTaskImportance", "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/BatchUpdateTaskImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Importance batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Task Importance" ], "summary": "Delete a collection of existing Task Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| version | TaskImportance->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": "BatchDeleteTaskImportance", "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/BatchDeleteTaskImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Importance batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskImportances/{id}/Active": { "patch": { "tags": [ "Task Importance" ], "summary": "Change the IsActive status for an existing Task Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| isActive | TaskImportance->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": "ChangeTaskImportanceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskImportanceIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskImportances/{id}/PermissionTree": { "patch": { "tags": [ "Task Importance" ], "summary": "Change the PermissionTree for an existing Task Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| permissionTreeId | TaskImportance->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeTaskImportancePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskImportancePermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskImportances/Batch/Active": { "patch": { "tags": [ "Task Importance" ], "summary": "Change the IsActive status for a collection of existing Task Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| isActive | TaskImportance->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": "BatchChangeTaskImportanceIsActive", "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/BatchChangeTaskImportanceIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskImportances/Batch/PermissionTree": { "patch": { "tags": [ "Task Importance" ], "summary": "Change the PermissionTree status for a collection of existing Task Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskImportance->Id | integer | int64 |\r\n| version | TaskImportance->Version | integer | int32 |\r\n| permissionTreeId | TaskImportance->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeTaskImportancePermissionTree", "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/BatchChangeTaskImportancePermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Intervals/{id}": { "get": { "tags": [ "Task Interval" ], "summary": "Get a Task Interval resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskInterval->Code | string | |\r\n| isActive | TaskInterval->IsActive | boolean | |\r\n| createdByUserId | TaskInterval->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskInterval->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskInterval->CreatedByUser_FullName | string | |\r\n| createdOn | TaskInterval->CreatedOn | string | date-time |\r\n| modifiedByUserId | TaskInterval->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskInterval->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskInterval->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskInterval->ModifiedOn | string | date-time |\r\n| version | TaskInterval->Version | integer | int32 |\r\n| permissionTreeId | TaskInterval->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskInterval->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskInterval->PermissionTree_Description | string | |\r\n| id | TaskInterval->Id | integer | int64 |\r\n| description | TaskInterval->Description | string | |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| measurementTypeInterval | TaskInterval->MeasurementTypeInterval | integer | int32 |\r\n| notes | TaskInterval->Notes | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| taskIntervalTypeCode | TaskInterval->TaskIntervalType_Code | string | |\r\n| taskIntervalTypeDescription | TaskInterval->TaskIntervalType_Description | string | |\r\n", "operationId": "GetTaskInterval", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Interval", "schema": { "$ref": "#/definitions/GetTaskIntervalResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Interval" ], "summary": "Update an existing Task Interval resource.", "description": "### Request Body\r\n#### 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 | TaskInterval->Version | integer | int32 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| notes | TaskInterval->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| interval | Nullable | False | |\r\n| taskIntervalTypeId | Nullable | False | |\r\n\r\n", "operationId": "UpdateTaskInterval", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTaskIntervalResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval 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": [ "Task Interval" ], "summary": "Delete an existing Task Interval resource.", "description": "### Request Body\r\n#### 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 | TaskInterval->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": "DeleteTaskInterval", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTaskIntervalResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval 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/AMPC/TaskIntervalTypes/Intervals": { "get": { "tags": [ "Task Interval" ], "summary": "Get a collection of Task Interval 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 | TaskInterval->Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| taskIntervalTypeCode | TaskInterval->TaskIntervalType_Code | string | |\r\n| taskIntervalTypeDescription | TaskInterval->TaskIntervalType_Description | string | |\r\n| taskIntervalTypeUnitOfMeasurementId | TaskInterval->TaskIntervalType_UnitOfMeasurement_Id | integer | int64 |\r\n| taskIntervalTypeUnitOfMeasurementCode | TaskInterval->TaskIntervalType_UnitOfMeasurement_Code | string | |\r\n| taskIntervalTypeUnitOfMeasurementDescription | TaskInterval->TaskIntervalType_UnitOfMeasurement_Description | string | |\r\n| notes | TaskInterval->Notes | string | |\r\n| createdOn | TaskInterval->CreatedOn | string | date-time |\r\n| modifiedOn | TaskInterval->ModifiedOn | string | date-time |\r\n| version | TaskInterval->Version | integer | int32 |\r\n", "operationId": "GetTaskIntervalCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval collection", "schema": { "$ref": "#/definitions/GetTaskIntervalCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Task Interval" ], "summary": "Create a new Task Interval resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskInterval->PermissionTree_Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| notes | TaskInterval->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| interval | Required | True | |\r\n| interval | Nullable | False | |\r\n| taskIntervalTypeId | Required | True | |\r\n| taskIntervalTypeId | Nullable | False | |\r\n\r\n", "operationId": "CreateTaskInterval", "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/CreateTaskIntervalResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/{id}/Intervals": { "get": { "tags": [ "Task Interval" ], "summary": "Get a collection of Task Interval resources for the Task Interval Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskInterval->Id | integer | int64 |\r\n| version | TaskInterval->Version | integer | int32 |\r\n| code | TaskInterval->Code | string | |\r\n| taskIntervalTypeUnitOfMeasurementId | TaskInterval->TaskIntervalType_UnitOfMeasurement_Id | integer | int64 |\r\n| taskIntervalTypeUnitOfMeasurementCode | TaskInterval->TaskIntervalType_UnitOfMeasurement_Code | string | |\r\n| taskIntervalTypeUnitOfMeasurementDescription | TaskInterval->TaskIntervalType_UnitOfMeasurement_Description | string | |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n", "operationId": "GetTaskIntervalForTaskIntervalTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Type 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 Task Interval collection", "schema": { "$ref": "#/definitions/GetTaskIntervalForTaskIntervalTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Intervals/Lookups/LookupTaskIntervalChangePermissionTree": { "get": { "tags": [ "Task Interval" ], "summary": "Lookup the permission set for changing the Task Interval.", "description": "### Response Body\r\n#### Payload\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": "LookupTaskIntervalChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskIntervalChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Intervals/Lookups/LookupTaskIntervalInsertPermissionTree": { "get": { "tags": [ "Task Interval" ], "summary": "Lookup the permission set for creating the Task Interval.", "description": "### Response Body\r\n#### Payload\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": "LookupTaskIntervalInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskIntervalInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Intervals/Lookups/LookupTaskIntervalTaskIntervalType": { "get": { "tags": [ "Task Interval" ], "summary": "Lookup the Task Interval Type for the Task Interval.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n", "operationId": "LookupTaskIntervalTaskIntervalType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval Type collection", "schema": { "$ref": "#/definitions/TaskIntervalTaskIntervalTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Intervals/Batch/{ids}": { "get": { "tags": [ "Task Interval" ], "summary": "Get a collection of Task Interval resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskInterval->Code | string | |\r\n| isActive | TaskInterval->IsActive | boolean | |\r\n| createdByUserId | TaskInterval->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskInterval->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskInterval->CreatedByUser_FullName | string | |\r\n| createdOn | TaskInterval->CreatedOn | string | date-time |\r\n| modifiedByUserId | TaskInterval->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskInterval->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskInterval->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskInterval->ModifiedOn | string | date-time |\r\n| version | TaskInterval->Version | integer | int32 |\r\n| permissionTreeId | TaskInterval->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskInterval->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskInterval->PermissionTree_Description | string | |\r\n| id | TaskInterval->Id | integer | int64 |\r\n| description | TaskInterval->Description | string | |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| measurementTypeInterval | TaskInterval->MeasurementTypeInterval | integer | int32 |\r\n| notes | TaskInterval->Notes | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| taskIntervalTypeCode | TaskInterval->TaskIntervalType_Code | string | |\r\n| taskIntervalTypeDescription | TaskInterval->TaskIntervalType_Description | string | |\r\n", "operationId": "BatchGetTaskInterval", "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 Task Interval 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 Task Interval collection", "schema": { "$ref": "#/definitions/BatchGetTaskIntervalResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Intervals/Batch": { "post": { "tags": [ "Task Interval" ], "summary": "Create a new collection of Task Interval resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskInterval->PermissionTree_Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| notes | TaskInterval->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| interval | Required | True | |\r\n| interval | Nullable | False | |\r\n| taskIntervalTypeId | Required | True | |\r\n| taskIntervalTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTaskInterval", "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/BatchCreateTaskIntervalResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Task Interval 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": [ "Task Interval" ], "summary": "Update a collection of existing Task Interval resources.", "description": "### Request Body\r\n#### 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 | TaskInterval->Id | integer | int64 |\r\n| version | TaskInterval->Version | integer | int32 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n| sequenceNumber | TaskInterval->SequenceNumber | integer | int32 |\r\n| interval | TaskInterval->Interval | integer | int32 |\r\n| taskIntervalTypeId | TaskInterval->TaskIntervalType_Id | integer | int64 |\r\n| notes | TaskInterval->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| interval | Nullable | False | |\r\n| taskIntervalTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateTaskInterval", "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/BatchUpdateTaskIntervalResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval 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": [ "Task Interval" ], "summary": "Delete a collection of existing Task Interval resources.", "description": "### Request Body\r\n#### 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 | TaskInterval->Id | integer | int64 |\r\n| version | TaskInterval->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": "BatchDeleteTaskInterval", "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/BatchDeleteTaskIntervalResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval 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/AMPC/TaskIntervalTypes/Intervals/{id}/Active": { "patch": { "tags": [ "Task Interval" ], "summary": "Change the IsActive status for an existing Task Interval resource.", "description": "### Request Body\r\n#### 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 | TaskInterval->Version | integer | int32 |\r\n| isActive | TaskInterval->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": "ChangeTaskIntervalIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskIntervalIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Intervals/{id}/PermissionTree": { "patch": { "tags": [ "Task Interval" ], "summary": "Change the PermissionTree for an existing Task Interval resource.", "description": "### Request Body\r\n#### 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 | TaskInterval->Version | integer | int32 |\r\n| permissionTreeId | TaskInterval->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeTaskIntervalPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskIntervalPermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Intervals/Batch/Active": { "patch": { "tags": [ "Task Interval" ], "summary": "Change the IsActive status for a collection of existing Task Interval resources.", "description": "### Request Body\r\n#### 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 | TaskInterval->Id | integer | int64 |\r\n| version | TaskInterval->Version | integer | int32 |\r\n| isActive | TaskInterval->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": "BatchChangeTaskIntervalIsActive", "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/BatchChangeTaskIntervalIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Intervals/Batch/PermissionTree": { "patch": { "tags": [ "Task Interval" ], "summary": "Change the PermissionTree status for a collection of existing Task Interval resources.", "description": "### Request Body\r\n#### 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 | TaskInterval->Id | integer | int64 |\r\n| version | TaskInterval->Version | integer | int32 |\r\n| permissionTreeId | TaskInterval->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeTaskIntervalPermissionTree", "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/BatchChangeTaskIntervalPermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/{id}": { "get": { "tags": [ "Task Interval Type" ], "summary": "Get a Task Interval Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskIntervalType->Code | string | |\r\n| isActive | TaskIntervalType->IsActive | boolean | |\r\n| createdByUserId | TaskIntervalType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskIntervalType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskIntervalType->CreatedByUser_FullName | string | |\r\n| createdOn | TaskIntervalType->CreatedOn | string | date-time |\r\n| modifiedByUserId | TaskIntervalType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskIntervalType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskIntervalType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskIntervalType->ModifiedOn | string | date-time |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| permissionTreeId | TaskIntervalType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskIntervalType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskIntervalType->PermissionTree_Description | string | |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| description | TaskIntervalType->Description | string | |\r\n| notes | TaskIntervalType->Notes | string | |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | TaskIntervalType->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | TaskIntervalType->UnitOfMeasurement_Description | string | |\r\n", "operationId": "GetTaskIntervalType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Interval Type", "schema": { "$ref": "#/definitions/GetTaskIntervalTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Interval Type" ], "summary": "Update an existing Task Interval Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | TaskIntervalType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| schedulingKind | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | True | TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage' |\r\n| unitOfMeasurementId | Nullable | False | TaskIntervalType->SchedulingKind eq 'Calendar' or TaskIntervalType->SchedulingKind eq 'Usage' |\r\n\r\n", "operationId": "UpdateTaskIntervalType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTaskIntervalTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Task Interval Type" ], "summary": "Delete an existing Task Interval Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskIntervalType->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": "DeleteTaskIntervalType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTaskIntervalTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes": { "get": { "tags": [ "Task Interval Type" ], "summary": "Get a collection of Task Interval Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | TaskIntervalType->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | TaskIntervalType->UnitOfMeasurement_Description | string | |\r\n| notes | TaskIntervalType->Notes | string | |\r\n| createdOn | TaskIntervalType->CreatedOn | string | date-time |\r\n| modifiedOn | TaskIntervalType->ModifiedOn | string | date-time |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n", "operationId": "GetTaskIntervalTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Interval Type collection", "schema": { "$ref": "#/definitions/GetTaskIntervalTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Task Interval Type" ], "summary": "Create a new Task Interval Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskIntervalType->PermissionTree_Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | TaskIntervalType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| schedulingKind | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | True | TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage' |\r\n| unitOfMeasurementId | Nullable | False | TaskIntervalType->SchedulingKind eq 'Calendar' or TaskIntervalType->SchedulingKind eq 'Usage' |\r\n\r\n", "operationId": "CreateTaskIntervalType", "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/CreateTaskIntervalTypeResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Lookups/LookupTaskIntervalTypeChangePermissionTree": { "get": { "tags": [ "Task Interval Type" ], "summary": "Lookup the permission set for changing the Task Interval Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupTaskIntervalTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskIntervalTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Lookups/LookupTaskIntervalTypeInsertPermissionTree": { "get": { "tags": [ "Task Interval Type" ], "summary": "Lookup the permission set for creating the Task Interval Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupTaskIntervalTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskIntervalTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Lookups/LookupTaskIntervalTypeUnitOfMeasurement": { "get": { "tags": [ "Task Interval Type" ], "summary": "Lookup the Unit Of Measurement for the Task Interval Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupTaskIntervalTypeUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/TaskIntervalTypeUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Batch/{ids}": { "get": { "tags": [ "Task Interval Type" ], "summary": "Get a collection of Task Interval Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskIntervalType->Code | string | |\r\n| isActive | TaskIntervalType->IsActive | boolean | |\r\n| createdByUserId | TaskIntervalType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskIntervalType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskIntervalType->CreatedByUser_FullName | string | |\r\n| createdOn | TaskIntervalType->CreatedOn | string | date-time |\r\n| modifiedByUserId | TaskIntervalType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskIntervalType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskIntervalType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskIntervalType->ModifiedOn | string | date-time |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| permissionTreeId | TaskIntervalType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskIntervalType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskIntervalType->PermissionTree_Description | string | |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| description | TaskIntervalType->Description | string | |\r\n| notes | TaskIntervalType->Notes | string | |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | TaskIntervalType->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | TaskIntervalType->UnitOfMeasurement_Description | string | |\r\n", "operationId": "BatchGetTaskIntervalType", "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 Task Interval Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Interval Type collection", "schema": { "$ref": "#/definitions/BatchGetTaskIntervalTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/Batch": { "post": { "tags": [ "Task Interval Type" ], "summary": "Create a new collection of Task Interval Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskIntervalType->PermissionTree_Id | integer | int64 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | TaskIntervalType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| schedulingKind | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | True | TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage' |\r\n| unitOfMeasurementId | Nullable | False | TaskIntervalType->SchedulingKind eq 'Calendar' or TaskIntervalType->SchedulingKind eq 'Usage' |\r\n\r\n", "operationId": "BatchCreateTaskIntervalType", "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/BatchCreateTaskIntervalTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Task Interval Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Interval Type" ], "summary": "Update a collection of existing Task Interval Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| code | TaskIntervalType->Code | string | |\r\n| description | TaskIntervalType->Description | string | |\r\n| sequenceNumber | TaskIntervalType->SequenceNumber | integer | int32 |\r\n| schedulingKind | TaskIntervalType->SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| unitOfMeasurementId | TaskIntervalType->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | TaskIntervalType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| schedulingKind | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | True | TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage' |\r\n| unitOfMeasurementId | Nullable | False | TaskIntervalType->SchedulingKind eq 'Calendar' or TaskIntervalType->SchedulingKind eq 'Usage' |\r\n\r\n", "operationId": "BatchUpdateTaskIntervalType", "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/BatchUpdateTaskIntervalTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Task Interval Type" ], "summary": "Delete a collection of existing Task Interval Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| version | TaskIntervalType->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": "BatchDeleteTaskIntervalType", "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/BatchDeleteTaskIntervalTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Interval Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskIntervalTypes/{id}/Active": { "patch": { "tags": [ "Task Interval Type" ], "summary": "Change the IsActive status for an existing Task Interval Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| isActive | TaskIntervalType->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": "ChangeTaskIntervalTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskIntervalTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/{id}/PermissionTree": { "patch": { "tags": [ "Task Interval Type" ], "summary": "Change the PermissionTree for an existing Task Interval Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| permissionTreeId | TaskIntervalType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeTaskIntervalTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Interval Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskIntervalTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Batch/Active": { "patch": { "tags": [ "Task Interval Type" ], "summary": "Change the IsActive status for a collection of existing Task Interval Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| isActive | TaskIntervalType->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": "BatchChangeTaskIntervalTypeIsActive", "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/BatchChangeTaskIntervalTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskIntervalTypes/Batch/PermissionTree": { "patch": { "tags": [ "Task Interval Type" ], "summary": "Change the PermissionTree status for a collection of existing Task Interval Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskIntervalType->Id | integer | int64 |\r\n| version | TaskIntervalType->Version | integer | int32 |\r\n| permissionTreeId | TaskIntervalType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeTaskIntervalTypePermissionTree", "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/BatchChangeTaskIntervalTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskRollUpPoints/{id}": { "get": { "tags": [ "Task Roll Up Point" ], "summary": "Get a Task Roll Up Point resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| createdByUserId | TaskRollUpPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskRollUpPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskRollUpPoint->CreatedByUser_FullName | string | |\r\n| createdOn | TaskRollUpPoint->CreatedOn | string | date-time |\r\n| isActive | TaskRollUpPoint->IsActive | boolean | |\r\n| modifiedByUserId | TaskRollUpPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskRollUpPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskRollUpPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskRollUpPoint->ModifiedOn | string | date-time |\r\n| permissionTreeId | TaskRollUpPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskRollUpPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskRollUpPoint->PermissionTree_Description | string | |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n", "operationId": "GetTaskRollUpPoint", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Roll Up Point Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Roll Up Point", "schema": { "$ref": "#/definitions/GetTaskRollUpPointResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Roll Up Point" ], "summary": "Update an existing Task Roll Up Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateTaskRollUpPoint", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Roll Up Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTaskRollUpPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Roll Up Point was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Task Roll Up Point" ], "summary": "Delete an existing Task Roll Up Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskRollUpPoint->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": "DeleteTaskRollUpPoint", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Roll Up Point Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTaskRollUpPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Roll Up Point 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/AMPC/TaskRollUpPoints": { "get": { "tags": [ "Task Roll Up Point" ], "summary": "Get a collection of Task Roll Up Point resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n| permissionTreeCode | TaskRollUpPoint->PermissionTree_Code | string | |\r\n| createdOn | TaskRollUpPoint->CreatedOn | string | date-time |\r\n| modifiedOn | TaskRollUpPoint->ModifiedOn | string | date-time |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n", "operationId": "GetTaskRollUpPointCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Task Roll Up Point collection", "schema": { "$ref": "#/definitions/GetTaskRollUpPointCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Task Roll Up Point" ], "summary": "Create a new Task Roll Up Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskRollUpPoint->PermissionTree_Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateTaskRollUpPoint", "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/CreateTaskRollUpPointResourceActionRequest" } }, { "$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/AMPC/TaskRollUpPoints/Lookups/LookupTaskRollUpPointChangePermissionTree": { "get": { "tags": [ "Task Roll Up Point" ], "summary": "Lookup the permission set for changing the Task Roll Up Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupTaskRollUpPointChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskRollUpPointChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskRollUpPoints/Lookups/LookupTaskRollUpPointInsertPermissionTree": { "get": { "tags": [ "Task Roll Up Point" ], "summary": "Lookup the permission set for creating the Task Roll Up Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupTaskRollUpPointInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TaskRollUpPointInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskRollUpPoints/Batch/{ids}": { "get": { "tags": [ "Task Roll Up Point" ], "summary": "Get a collection of Task Roll Up Point resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| createdByUserId | TaskRollUpPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TaskRollUpPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TaskRollUpPoint->CreatedByUser_FullName | string | |\r\n| createdOn | TaskRollUpPoint->CreatedOn | string | date-time |\r\n| isActive | TaskRollUpPoint->IsActive | boolean | |\r\n| modifiedByUserId | TaskRollUpPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TaskRollUpPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TaskRollUpPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TaskRollUpPoint->ModifiedOn | string | date-time |\r\n| permissionTreeId | TaskRollUpPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TaskRollUpPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TaskRollUpPoint->PermissionTree_Description | string | |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetTaskRollUpPoint", "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 Task Roll Up Point id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Task Roll Up Point collection", "schema": { "$ref": "#/definitions/BatchGetTaskRollUpPointResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TaskRollUpPoints/Batch": { "post": { "tags": [ "Task Roll Up Point" ], "summary": "Create a new collection of Task Roll Up Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | TaskRollUpPoint->PermissionTree_Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateTaskRollUpPoint", "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/BatchCreateTaskRollUpPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Task Roll Up Point batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Task Roll Up Point" ], "summary": "Update a collection of existing Task Roll Up Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n| sequenceNumber | TaskRollUpPoint->SequenceNumber | integer | int32 |\r\n| notes | TaskRollUpPoint->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateTaskRollUpPoint", "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/BatchUpdateTaskRollUpPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Roll Up Point batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Task Roll Up Point" ], "summary": "Delete a collection of existing Task Roll Up Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| version | TaskRollUpPoint->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": "BatchDeleteTaskRollUpPoint", "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/BatchDeleteTaskRollUpPointResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Task Roll Up Point 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/AMPC/TaskRollUpPoints/{id}/Active": { "patch": { "tags": [ "Task Roll Up Point" ], "summary": "Change the IsActive status for an existing Task Roll Up Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| isActive | TaskRollUpPoint->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": "ChangeTaskRollUpPointIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Roll Up Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskRollUpPointIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskRollUpPoints/{id}/PermissionTree": { "patch": { "tags": [ "Task Roll Up Point" ], "summary": "Change the PermissionTree for an existing Task Roll Up Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| permissionTreeId | TaskRollUpPoint->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeTaskRollUpPointPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Task Roll Up Point Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTaskRollUpPointPermissionTreeResourceActionRequest" } }, { "$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/AMPC/TaskRollUpPoints/Batch/Active": { "patch": { "tags": [ "Task Roll Up Point" ], "summary": "Change the IsActive status for a collection of existing Task Roll Up Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| isActive | TaskRollUpPoint->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": "BatchChangeTaskRollUpPointIsActive", "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/BatchChangeTaskRollUpPointIsActiveResourceActionRequest" } }, { "$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/AMPC/TaskRollUpPoints/Batch/PermissionTree": { "patch": { "tags": [ "Task Roll Up Point" ], "summary": "Change the PermissionTree status for a collection of existing Task Roll Up Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TaskRollUpPoint->Id | integer | int64 |\r\n| version | TaskRollUpPoint->Version | integer | int32 |\r\n| permissionTreeId | TaskRollUpPoint->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeTaskRollUpPointPermissionTree", "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/BatchChangeTaskRollUpPointPermissionTreeResourceActionRequest" } }, { "$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/AMPC/TypesOfWork/{id}": { "get": { "tags": [ "Type of Work" ], "summary": "Get a 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| code | TypeOfWork->Code | string | |\r\n| isActive | TypeOfWork->IsActive | boolean | |\r\n| createdByUserId | TypeOfWork->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TypeOfWork->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TypeOfWork->CreatedByUser_FullName | string | |\r\n| createdOn | TypeOfWork->CreatedOn | string | date-time |\r\n| modifiedByUserId | TypeOfWork->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TypeOfWork->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TypeOfWork->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TypeOfWork->ModifiedOn | string | date-time |\r\n| version | TypeOfWork->Version | integer | int32 |\r\n| permissionTreeId | TypeOfWork->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TypeOfWork->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TypeOfWork->PermissionTree_Description | string | |\r\n| id | TypeOfWork->Id | integer | int64 |\r\n| description | TypeOfWork->Description | string | |\r\n| notes | TypeOfWork->Notes | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | TypeOfWork->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | TypeOfWork->WorkOrderStatus_Description | string | |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n", "operationId": "GetTypeOfWork", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Type of Work Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Type of Work", "schema": { "$ref": "#/definitions/GetTypeOfWorkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Type of Work" ], "summary": "Update an existing 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 | TypeOfWork->Version | integer | int32 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| notes | TypeOfWork->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateTypeOfWork", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Type of Work Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Type of Work 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": [ "Type of Work" ], "summary": "Delete an existing 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 | TypeOfWork->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": "DeleteTypeOfWork", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Type of Work Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - 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/AMPC/TypesOfWork": { "get": { "tags": [ "Type of Work" ], "summary": "Get a collection of 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| id | TypeOfWork->Id | integer | int64 |\r\n| version | TypeOfWork->Version | integer | int32 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| notes | TypeOfWork->Notes | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | TypeOfWork->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | TypeOfWork->WorkOrderStatus_Description | string | |\r\n| createdOn | TypeOfWork->CreatedOn | string | date-time |\r\n| modifiedOn | TypeOfWork->ModifiedOn | string | date-time |\r\n", "operationId": "GetTypeOfWorkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/GetTypeOfWorkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Type of Work" ], "summary": "Create a new 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| permissionTreeId | TypeOfWork->PermissionTree_Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| notes | TypeOfWork->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| workClass | Required | True | |\r\n| workClass | Nullable | False | |\r\n\r\n", "operationId": "CreateTypeOfWork", "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/CreateTypeOfWorkResourceActionRequest" } }, { "$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/AMPC/TypesOfWork/Lookups/LookupTypeOfWorkChangePermissionTree": { "get": { "tags": [ "Type of Work" ], "summary": "Lookup the permission set for changing the Type of Work.", "description": "### Response Body\r\n#### Payload\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": "LookupTypeOfWorkChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TypeOfWorkChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TypesOfWork/Lookups/LookupTypeOfWorkInsertPermissionTree": { "get": { "tags": [ "Type of Work" ], "summary": "Lookup the permission set for creating the Type of Work.", "description": "### Response Body\r\n#### Payload\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": "LookupTypeOfWorkInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TypeOfWorkInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TypesOfWork/Lookups/LookupTypeOfWorkWorkOrderStatus": { "get": { "tags": [ "Type of Work" ], "summary": "Lookup the Work Order Status for the Type of Work.", "description": "### Response Body\r\n#### Payload\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": "LookupTypeOfWorkWorkOrderStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/TypeOfWorkWorkOrderStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TypesOfWork/Batch/{ids}": { "get": { "tags": [ "Type of Work" ], "summary": "Get a collection of 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| code | TypeOfWork->Code | string | |\r\n| isActive | TypeOfWork->IsActive | boolean | |\r\n| createdByUserId | TypeOfWork->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TypeOfWork->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TypeOfWork->CreatedByUser_FullName | string | |\r\n| createdOn | TypeOfWork->CreatedOn | string | date-time |\r\n| modifiedByUserId | TypeOfWork->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TypeOfWork->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TypeOfWork->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TypeOfWork->ModifiedOn | string | date-time |\r\n| version | TypeOfWork->Version | integer | int32 |\r\n| permissionTreeId | TypeOfWork->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TypeOfWork->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TypeOfWork->PermissionTree_Description | string | |\r\n| id | TypeOfWork->Id | integer | int64 |\r\n| description | TypeOfWork->Description | string | |\r\n| notes | TypeOfWork->Notes | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| workOrderStatusCode | TypeOfWork->WorkOrderStatus_Code | string | |\r\n| workOrderStatusDescription | TypeOfWork->WorkOrderStatus_Description | string | |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n", "operationId": "BatchGetTypeOfWork", "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 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 Type of Work collection", "schema": { "$ref": "#/definitions/BatchGetTypeOfWorkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/TypesOfWork/Batch": { "post": { "tags": [ "Type of Work" ], "summary": "Create a new collection of 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| permissionTreeId | TypeOfWork->PermissionTree_Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| notes | TypeOfWork->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| workClass | Required | True | |\r\n| workClass | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTypeOfWork", "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/BatchCreateTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - 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" } } }, "patch": { "tags": [ "Type of Work" ], "summary": "Update a collection of existing 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 | TypeOfWork->Id | integer | int64 |\r\n| version | TypeOfWork->Version | integer | int32 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n| requiresFailedComponent | TypeOfWork->RequiresFailedComponent | boolean | |\r\n| requiresFailureModeType | TypeOfWork->RequiresFailureModeType | boolean | |\r\n| requiresFailureMode | TypeOfWork->RequiresFailureMode | boolean | |\r\n| requiresFailureMechanismType | TypeOfWork->RequiresFailureMechanismType | boolean | |\r\n| requiresFailureMechanism | TypeOfWork->RequiresFailureMechanism | boolean | |\r\n| requiresFailureCauseType | TypeOfWork->RequiresFailureCauseType | boolean | |\r\n| requiresFailureCause | TypeOfWork->RequiresFailureCause | boolean | |\r\n| requiresRepairType | TypeOfWork->RequiresRepairType | boolean | |\r\n| sequenceNumber | TypeOfWork->SequenceNumber | integer | int32 |\r\n| workClass | TypeOfWork->WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| workTactic | TypeOfWork->WorkTactic | string (Allowed values: [RunToFailure, ConditionBased, UsageBased, DesignImprovement]) | enum |\r\n| workType | TypeOfWork->WorkType | string (Allowed values: [Breakdown, Reactive, AdHoc, Inspect, FollowUp]) | enum |\r\n| workOrderStatusId | TypeOfWork->WorkOrderStatus_Id | integer | int64 |\r\n| notes | TypeOfWork->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateTypeOfWork", "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/BatchUpdateTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Type of Work 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": [ "Type of Work" ], "summary": "Delete a collection of existing 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 | TypeOfWork->Id | integer | int64 |\r\n| version | TypeOfWork->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": "BatchDeleteTypeOfWork", "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/BatchDeleteTypeOfWorkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - 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/AMPC/TypesOfWork/{id}/Active": { "patch": { "tags": [ "Type of Work" ], "summary": "Change the IsActive status for an existing 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 | TypeOfWork->Version | integer | int32 |\r\n| isActive | TypeOfWork->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": "ChangeTypeOfWorkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Type of Work Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTypeOfWorkIsActiveResourceActionRequest" } }, { "$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/AMPC/TypesOfWork/{id}/PermissionTree": { "patch": { "tags": [ "Type of Work" ], "summary": "Change the PermissionTree for an existing 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 | TypeOfWork->Version | integer | int32 |\r\n| permissionTreeId | TypeOfWork->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeTypeOfWorkPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Type of Work Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTypeOfWorkPermissionTreeResourceActionRequest" } }, { "$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/AMPC/TypesOfWork/Batch/Active": { "patch": { "tags": [ "Type of Work" ], "summary": "Change the IsActive status for a collection of existing 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 | TypeOfWork->Id | integer | int64 |\r\n| version | TypeOfWork->Version | integer | int32 |\r\n| isActive | TypeOfWork->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": "BatchChangeTypeOfWorkIsActive", "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/BatchChangeTypeOfWorkIsActiveResourceActionRequest" } }, { "$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/AMPC/TypesOfWork/Batch/PermissionTree": { "patch": { "tags": [ "Type of Work" ], "summary": "Change the PermissionTree status for a collection of existing 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 | TypeOfWork->Id | integer | int64 |\r\n| version | TypeOfWork->Version | integer | int32 |\r\n| permissionTreeId | TypeOfWork->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeTypeOfWorkPermissionTree", "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/BatchChangeTypeOfWorkPermissionTreeResourceActionRequest" } }, { "$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/AMPC/WarrantyTypes/{id}": { "get": { "tags": [ "Warranty Type" ], "summary": "Get a Warranty Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | WarrantyType->Code | string | |\r\n| isActive | WarrantyType->IsActive | boolean | |\r\n| createdByUserId | WarrantyType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WarrantyType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WarrantyType->CreatedByUser_FullName | string | |\r\n| createdOn | WarrantyType->CreatedOn | string | date-time |\r\n| modifiedByUserId | WarrantyType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WarrantyType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WarrantyType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WarrantyType->ModifiedOn | string | date-time |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| permissionTreeId | WarrantyType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WarrantyType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WarrantyType->PermissionTree_Description | string | |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| description | WarrantyType->Description | string | |\r\n| notes | WarrantyType->Notes | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWarrantyType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Warranty Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Warranty Type", "schema": { "$ref": "#/definitions/GetWarrantyTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Warranty Type" ], "summary": "Update an existing Warranty Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| code | WarrantyType->Code | string | |\r\n| description | WarrantyType->Description | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n| notes | WarrantyType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateWarrantyType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Warranty Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateWarrantyTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Warranty Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Warranty Type" ], "summary": "Delete an existing Warranty Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WarrantyType->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": "DeleteWarrantyType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Warranty Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteWarrantyTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Warranty Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/WarrantyTypes": { "get": { "tags": [ "Warranty Type" ], "summary": "Get a collection of Warranty Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| code | WarrantyType->Code | string | |\r\n| description | WarrantyType->Description | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetWarrantyTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Warranty Type collection", "schema": { "$ref": "#/definitions/GetWarrantyTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Warranty Type" ], "summary": "Create a new Warranty Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | WarrantyType->PermissionTree_Id | integer | int64 |\r\n| code | WarrantyType->Code | string | |\r\n| description | WarrantyType->Description | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n| notes | WarrantyType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreateWarrantyType", "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/CreateWarrantyTypeResourceActionRequest" } }, { "$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/AMPC/WarrantyTypes/Lookups/LookupWarrantyTypeChangePermissionTree": { "get": { "tags": [ "Warranty Type" ], "summary": "Lookup the permission set for changing the Warranty Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupWarrantyTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WarrantyTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/WarrantyTypes/Lookups/LookupWarrantyTypeInsertPermissionTree": { "get": { "tags": [ "Warranty Type" ], "summary": "Lookup the permission set for creating the Warranty Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupWarrantyTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/WarrantyTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/WarrantyTypes/Batch/{ids}": { "get": { "tags": [ "Warranty Type" ], "summary": "Get a collection of Warranty Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | WarrantyType->Code | string | |\r\n| isActive | WarrantyType->IsActive | boolean | |\r\n| createdByUserId | WarrantyType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | WarrantyType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | WarrantyType->CreatedByUser_FullName | string | |\r\n| createdOn | WarrantyType->CreatedOn | string | date-time |\r\n| modifiedByUserId | WarrantyType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | WarrantyType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | WarrantyType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | WarrantyType->ModifiedOn | string | date-time |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| permissionTreeId | WarrantyType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | WarrantyType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | WarrantyType->PermissionTree_Description | string | |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| description | WarrantyType->Description | string | |\r\n| notes | WarrantyType->Notes | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetWarrantyType", "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 Warranty Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Warranty Type collection", "schema": { "$ref": "#/definitions/BatchGetWarrantyTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/WarrantyTypes/Batch": { "post": { "tags": [ "Warranty Type" ], "summary": "Create a new collection of Warranty Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | WarrantyType->PermissionTree_Id | integer | int64 |\r\n| code | WarrantyType->Code | string | |\r\n| description | WarrantyType->Description | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n| notes | WarrantyType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreateWarrantyType", "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/BatchCreateWarrantyTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Warranty Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Warranty Type" ], "summary": "Update a collection of existing Warranty Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| code | WarrantyType->Code | string | |\r\n| description | WarrantyType->Description | string | |\r\n| sequenceNumber | WarrantyType->SequenceNumber | integer | int32 |\r\n| notes | WarrantyType->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateWarrantyType", "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/BatchUpdateWarrantyTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Warranty Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Warranty Type" ], "summary": "Delete a collection of existing Warranty Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| version | WarrantyType->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": "BatchDeleteWarrantyType", "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/BatchDeleteWarrantyTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Warranty Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/WarrantyTypes/{id}/Active": { "patch": { "tags": [ "Warranty Type" ], "summary": "Change the IsActive status for an existing Warranty Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| isActive | WarrantyType->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": "ChangeWarrantyTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Warranty Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWarrantyTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/WarrantyTypes/{id}/PermissionTree": { "patch": { "tags": [ "Warranty Type" ], "summary": "Change the PermissionTree for an existing Warranty Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| permissionTreeId | WarrantyType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeWarrantyTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Warranty Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeWarrantyTypePermissionTreeResourceActionRequest" } }, { "$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/AMPC/WarrantyTypes/Batch/Active": { "patch": { "tags": [ "Warranty Type" ], "summary": "Change the IsActive status for a collection of existing Warranty Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| isActive | WarrantyType->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": "BatchChangeWarrantyTypeIsActive", "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/BatchChangeWarrantyTypeIsActiveResourceActionRequest" } }, { "$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/AMPC/WarrantyTypes/Batch/PermissionTree": { "patch": { "tags": [ "Warranty Type" ], "summary": "Change the PermissionTree status for a collection of existing Warranty Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WarrantyType->Id | integer | int64 |\r\n| version | WarrantyType->Version | integer | int32 |\r\n| permissionTreeId | WarrantyType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeWarrantyTypePermissionTree", "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/BatchChangeWarrantyTypePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "required": [ "permissionId", "permissionTreeId", "propertyPaths" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "required": [ "phrase", "translation", "propertyPaths" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link" }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link" }, "rel": { "type": "string" }, "resource": { "type": "string", "description": "Resource used by link" }, "resourceAction": { "type": "string", "description": "Resource Action used by link" }, "title": { "type": "string", "description": "Title" }, "type": { "description": "Type of link", "$ref": "#/definitions/ResourceLinkType" } } }, "LinkMapping": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string" } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetAssetWarrantyResourceActionResponse": { "title": "GetAssetWarrantyResourceActionResponse", "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": "GetAssetWarrantyResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetWarranty->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetWarranty->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetWarranty->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetWarranty->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Notes" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Code" }, "warrantyTypeDescription": { "title": "warrantyTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_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" } } }, "TreePathItem": { "type": "object", "required": [ "sequence" ], "properties": { "sequence": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "description": { "type": "string" }, "alternativeDescription": { "type": "string" } } }, "GetAssetWarrantyCollectionResourceActionResponse": { "title": "GetAssetWarrantyCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetWarrantyCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetWarrantyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Asset_Id" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetWarranty->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Asset_Code" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_Id" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetWarranty->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_Code" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Code" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetWarranty->LinkedToEntityType", "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" } } } }, "GetAssetWarrantyForInPlaceAssetCollectionResourceActionResponse": { "title": "GetAssetWarrantyForInPlaceAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetWarrantyForInPlaceAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetWarrantyForInPlaceAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAssetWarrantyForPlaceholderAssetCollectionResourceActionResponse": { "title": "GetAssetWarrantyForPlaceholderAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetWarrantyForPlaceholderAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetWarrantyForPlaceholderAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAssetWarrantyForPlaceholderAssetComponentCollectionResourceActionResponse": { "title": "GetAssetWarrantyForPlaceholderAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetWarrantyForPlaceholderAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetWarrantyForPlaceholderAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAssetWarrantyForRegularAssetCollectionResourceActionResponse": { "title": "GetAssetWarrantyForRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetWarrantyForRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetWarrantyForRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAssetWarrantiesForRegularAssetComponentCollectionResourceActionResponse": { "title": "GetAssetWarrantiesForRegularAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetWarrantiesForRegularAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetWarrantiesForRegularAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "expired": { "title": "expired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetWarranty->Expired" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->Supplier_Code" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyTypeCode": { "title": "warrantyTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetWarrantyAssetLookupResourceActionResponse": { "title": "AssetWarrantyAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetWarrantyAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetWarrantyAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetWarrantyChangePermissionTreeLookupResourceActionResponse": { "title": "AssetWarrantyChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetWarrantyChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetWarrantyChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetWarrantyComponentLookupResourceActionResponse": { "title": "AssetWarrantyComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetWarrantyComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetWarrantyComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetWarrantyInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetWarrantyInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetWarrantyInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetWarrantyInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetWarrantiesSupplierLookupResourceActionResponse": { "title": "AssetWarrantiesSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetWarrantiesSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetWarrantiesSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetWarrantiesWarrantyTypeLookupResourceActionResponse": { "title": "AssetWarrantiesWarrantyTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetWarrantiesWarrantyTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetWarrantiesWarrantyTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WarrantyType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WarrantyType->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" } } } }, "CreateAssetWarrantyResourceActionRequest": { "title": "CreateAssetWarrantyResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAssetWarrantyResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId", "warrantyTypeId", "warrantyExpiryDate", "strict", "code", "description" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->Asset_Id" }, "warrantyTypeId": { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, "warrantyExpiryDate": { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, "strict": { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Component_Id" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "x-nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/definitions/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "x-nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "x-nullable": true, "example": "BOILER" } } }, "UpdateAssetWarrantyResourceActionRequest": { "title": "UpdateAssetWarrantyResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetWarranty->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetWarranty->Description" }, { "title": "warrantyExpiryDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "AssetWarranty->WarrantyExpiryDate" }, { "title": "warrantyTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->WarrantyType_Id" }, { "title": "strict", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetWarranty->Strict" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetWarranty->Supplier_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetWarranty->Notes" } ] } } }, "DeleteAssetWarrantyResourceActionRequest": { "title": "DeleteAssetWarrantyResourceActionRequest", "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 } } }, "BatchGetAssetWarrantyResourceAction": { "title": "BatchGetAssetWarrantyResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Warranty entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Warranty entities", "items": { "$ref": "#/definitions/GetAssetWarrantyResourceActionResponse" } }, "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" } } }, "BatchCreateAssetWarrantyResourceActionRequest": { "title": "BatchCreateAssetWarrantyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetWarrantyResourceActionRequest" } }, "BatchUpdateAssetWarrantyResourceActionRequest": { "title": "BatchUpdateAssetWarrantyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetWarrantyResourceActionRequest" } }, "BatchDeleteAssetWarrantyResourceActionRequest": { "title": "BatchDeleteAssetWarrantyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAssetWarrantyResourceActionRequest" } }, "ChangeAssetWarrantyIsActiveResourceActionRequest": { "title": "ChangeAssetWarrantyIsActiveResourceActionRequest", "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": "AssetWarranty->IsActive" } ] } } }, "ChangeAssetWarrantyPermissionTreeResourceActionRequest": { "title": "ChangeAssetWarrantyPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetWarranty->PermissionTree_Id" } ] } } }, "BatchChangeAssetWarrantyIsActiveResourceActionRequest": { "title": "BatchChangeAssetWarrantyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetWarrantyIsActiveResourceActionRequest" } }, "BatchChangeAssetWarrantyPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetWarrantyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetWarrantyPermissionTreeResourceActionRequest" } }, "GetConditionResourceActionResponse": { "title": "GetConditionResourceActionResponse", "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": "GetConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Condition->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Condition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Condition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Condition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->PermissionTree_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Condition->AdjustmentFactor" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Condition->ConditionType_Id" }, "conditionTypeCode": { "title": "conditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Code" }, "conditionTypeDescription": { "title": "conditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Condition->SequenceNumber" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Condition->State", "x-formatSpecifier": "ConditionState" } } }, "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" } } }, "GetConditionCollectionResourceActionResponse": { "title": "GetConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Condition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Condition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Condition->State", "x-formatSpecifier": "ConditionState" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Condition->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Condition->ModifiedOn" }, "conditionTypeCode": { "title": "conditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->ConditionType_Code" }, "conditionTypeDescription": { "title": "conditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->ConditionType_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" } } } }, "GetConditionForConditionTypeCollectionResourceActionResponse": { "title": "GetConditionForConditionTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConditionForConditionTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConditionForConditionTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Condition->Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Condition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Condition->State", "x-formatSpecifier": "ConditionState" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "ConditionChangePermissionTreeLookupResourceActionResponse": { "title": "ConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ConditionConditionTypeLookupResourceActionResponse": { "title": "ConditionConditionTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConditionConditionTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ConditionConditionTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ConditionType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ConditionType->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" } } } }, "ConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "ConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateConditionResourceActionRequest": { "title": "CreateConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "conditionTypeId", "state" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Condition->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Condition->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Condition->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Condition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Condition->AdjustmentFactor" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Condition->ConditionType_Id" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Condition->State", "x-formatSpecifier": "ConditionState" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateConditionResourceActionRequest": { "title": "UpdateConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Condition->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Condition->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Condition->SequenceNumber" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Condition->AdjustmentFactor" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Condition->State", "x-formatSpecifier": "ConditionState" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Condition->Notes" } ] } } }, "DeleteConditionResourceActionRequest": { "title": "DeleteConditionResourceActionRequest", "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 } } }, "BatchGetConditionResourceAction": { "title": "BatchGetConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Condition entities", "items": { "$ref": "#/definitions/GetConditionResourceActionResponse" } }, "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" } } }, "BatchCreateConditionResourceActionRequest": { "title": "BatchCreateConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateConditionResourceActionRequest" } }, "BatchUpdateConditionResourceActionRequest": { "title": "BatchUpdateConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateConditionResourceActionRequest" } }, "BatchDeleteConditionResourceActionRequest": { "title": "BatchDeleteConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteConditionResourceActionRequest" } }, "ChangeConditionIsActiveResourceActionRequest": { "title": "ChangeConditionIsActiveResourceActionRequest", "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": "Condition->IsActive" } ] } } }, "ChangeConditionPermissionTreeResourceActionRequest": { "title": "ChangeConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Condition->PermissionTree_Id" } ] } } }, "BatchChangeConditionIsActiveResourceActionRequest": { "title": "BatchChangeConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeConditionIsActiveResourceActionRequest" } }, "BatchChangeConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeConditionPermissionTreeResourceActionRequest" } }, "GetConditionTypeResourceActionResponse": { "title": "GetConditionTypeResourceActionResponse", "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": "GetConditionTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ConditionType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ConditionType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ConditionType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ConditionType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ConditionType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ConditionType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ConditionType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ConditionType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ConditionType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetConditionTypeCollectionResourceActionResponse": { "title": "GetConditionTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConditionTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConditionTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ConditionType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ConditionType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ConditionType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ConditionType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ConditionType->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" } } } }, "ConditionTypeChangePermissionTreeLookupResourceActionResponse": { "title": "ConditionTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConditionTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ConditionTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ConditionTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "ConditionTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConditionTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "ConditionTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateConditionTypeResourceActionRequest": { "title": "CreateConditionTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateConditionTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ConditionType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ConditionType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ConditionType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ConditionType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateConditionTypeResourceActionRequest": { "title": "UpdateConditionTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ConditionType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ConditionType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ConditionType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ConditionType->Notes" } ] } } }, "DeleteConditionTypeResourceActionRequest": { "title": "DeleteConditionTypeResourceActionRequest", "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 } } }, "BatchGetConditionTypeResourceAction": { "title": "BatchGetConditionTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Condition Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Condition Type entities", "items": { "$ref": "#/definitions/GetConditionTypeResourceActionResponse" } }, "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" } } }, "BatchCreateConditionTypeResourceActionRequest": { "title": "BatchCreateConditionTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateConditionTypeResourceActionRequest" } }, "BatchUpdateConditionTypeResourceActionRequest": { "title": "BatchUpdateConditionTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateConditionTypeResourceActionRequest" } }, "BatchDeleteConditionTypeResourceActionRequest": { "title": "BatchDeleteConditionTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteConditionTypeResourceActionRequest" } }, "ChangeConditionTypeIsActiveResourceActionRequest": { "title": "ChangeConditionTypeIsActiveResourceActionRequest", "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": "ConditionType->IsActive" } ] } } }, "ChangeConditionTypePermissionTreeResourceActionRequest": { "title": "ChangeConditionTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ConditionType->PermissionTree_Id" } ] } } }, "BatchChangeConditionTypeIsActiveResourceActionRequest": { "title": "BatchChangeConditionTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeConditionTypeIsActiveResourceActionRequest" } }, "BatchChangeConditionTypePermissionTreeResourceActionRequest": { "title": "BatchChangeConditionTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeConditionTypePermissionTreeResourceActionRequest" } }, "GetEventResourceActionResponse": { "title": "GetEventResourceActionResponse", "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": "GetEventResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Event->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Event->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Event->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Event->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Event->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Event->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Event->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Event->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Event->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Event->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Event->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Event->PermissionTree_Description" }, "adjustWorkOrders": { "title": "adjustWorkOrders", "type": "boolean", "x-nullable": false, "x-propertyPath": "Event->AdjustWorkOrders" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Description" }, "eventDate": { "title": "eventDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "Event->EventDate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Event->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Event->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetEventCollectionResourceActionResponse": { "title": "GetEventCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetEventCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetEventCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Event->SequenceNumber" }, "eventDate": { "title": "eventDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "Event->EventDate" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Event->PermissionTree_Code" }, "adjustWorkOrders": { "title": "adjustWorkOrders", "type": "boolean", "x-nullable": false, "x-propertyPath": "Event->AdjustWorkOrders" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Event->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Event->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Event->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" } } } }, "EventChangePermissionTreeLookupResourceActionResponse": { "title": "EventChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "EventChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "EventChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "EventInsertPermissionTreeLookupResourceActionResponse": { "title": "EventInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "EventInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "EventInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateEventResourceActionRequest": { "title": "CreateEventResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateEventResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "eventDate", "adjustWorkOrders" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Event->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Event->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Event->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Event->SequenceNumber" }, "eventDate": { "title": "eventDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "Event->EventDate" }, "adjustWorkOrders": { "title": "adjustWorkOrders", "type": "boolean", "x-nullable": false, "x-propertyPath": "Event->AdjustWorkOrders" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Event->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateEventResourceActionRequest": { "title": "UpdateEventResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Event->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Event->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Event->SequenceNumber" }, { "title": "eventDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "Event->EventDate" }, { "title": "adjustWorkOrders", "type": "boolean", "x-nullable": false, "x-propertyPath": "Event->AdjustWorkOrders" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Event->Notes" } ] } } }, "DeleteEventResourceActionRequest": { "title": "DeleteEventResourceActionRequest", "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 } } }, "BatchGetEventResourceAction": { "title": "BatchGetEventResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Event entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Event entities", "items": { "$ref": "#/definitions/GetEventResourceActionResponse" } }, "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" } } }, "BatchCreateEventResourceActionRequest": { "title": "BatchCreateEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateEventResourceActionRequest" } }, "BatchUpdateEventResourceActionRequest": { "title": "BatchUpdateEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateEventResourceActionRequest" } }, "BatchDeleteEventResourceActionRequest": { "title": "BatchDeleteEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteEventResourceActionRequest" } }, "ChangeEventIsActiveResourceActionRequest": { "title": "ChangeEventIsActiveResourceActionRequest", "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": "Event->IsActive" } ] } } }, "ChangeEventPermissionTreeResourceActionRequest": { "title": "ChangeEventPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Event->PermissionTree_Id" } ] } } }, "BatchChangeEventIsActiveResourceActionRequest": { "title": "BatchChangeEventIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeEventIsActiveResourceActionRequest" } }, "BatchChangeEventPermissionTreeResourceActionRequest": { "title": "BatchChangeEventPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeEventPermissionTreeResourceActionRequest" } }, "GetFailureCauseResourceActionResponse": { "title": "GetFailureCauseResourceActionResponse", "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": "GetFailureCauseResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FailureCause->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCause->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCause->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCause->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->PermissionTree_Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCause->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFailureCauseCollectionResourceActionResponse": { "title": "GetFailureCauseCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFailureCauseCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFailureCauseCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCause->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->Notes" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->PermissionTree_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCause->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCause->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" } } } }, "FailureCauseChangePermissionTreeLookupResourceActionResponse": { "title": "FailureCauseChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureCauseChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureCauseChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "FailureCauseFailureCauseTypeLookupResourceActionResponse": { "title": "FailureCauseFailureCauseTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureCauseFailureCauseTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureCauseFailureCauseTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FailureCauseInsertPermissionTreeLookupResourceActionResponse": { "title": "FailureCauseInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureCauseInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureCauseInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateFailureCauseResourceActionRequest": { "title": "CreateFailureCauseResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFailureCauseResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "failureCauseTypeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCause->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCause->SequenceNumber" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFailureCauseResourceActionRequest": { "title": "UpdateFailureCauseResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCause->SequenceNumber" }, { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCause->Notes" } ] } } }, "DeleteFailureCauseResourceActionRequest": { "title": "DeleteFailureCauseResourceActionRequest", "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 } } }, "BatchGetFailureCauseResourceAction": { "title": "BatchGetFailureCauseResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Failure Cause entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Failure Cause entities", "items": { "$ref": "#/definitions/GetFailureCauseResourceActionResponse" } }, "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" } } }, "BatchCreateFailureCauseResourceActionRequest": { "title": "BatchCreateFailureCauseResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFailureCauseResourceActionRequest" } }, "BatchUpdateFailureCauseResourceActionRequest": { "title": "BatchUpdateFailureCauseResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFailureCauseResourceActionRequest" } }, "BatchDeleteFailureCauseResourceActionRequest": { "title": "BatchDeleteFailureCauseResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFailureCauseResourceActionRequest" } }, "ChangeFailureCauseIsActiveResourceActionRequest": { "title": "ChangeFailureCauseIsActiveResourceActionRequest", "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": "FailureCause->IsActive" } ] } } }, "ChangeFailureCausePermissionTreeResourceActionRequest": { "title": "ChangeFailureCausePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCause->PermissionTree_Id" } ] } } }, "BatchChangeFailureCauseIsActiveResourceActionRequest": { "title": "BatchChangeFailureCauseIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureCauseIsActiveResourceActionRequest" } }, "BatchChangeFailureCausePermissionTreeResourceActionRequest": { "title": "BatchChangeFailureCausePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureCausePermissionTreeResourceActionRequest" } }, "GetFailureCauseTypeResourceActionResponse": { "title": "GetFailureCauseTypeResourceActionResponse", "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": "GetFailureCauseTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCauseType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCauseType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCauseType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCauseType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCauseType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FailureCauseType->IsActive" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCauseType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFailureCauseTypeCollectionResourceActionResponse": { "title": "GetFailureCauseTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFailureCauseTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFailureCauseTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCauseType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCauseType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCauseType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureCauseType->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" } } } }, "FailureCauseTypeChangePermissionTreeLookupResourceActionResponse": { "title": "FailureCauseTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureCauseTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureCauseTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "FailureCauseTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "FailureCauseTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureCauseTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureCauseTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateFailureCauseTypeResourceActionRequest": { "title": "CreateFailureCauseTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFailureCauseTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCauseType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCauseType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCauseType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFailureCauseTypeResourceActionRequest": { "title": "UpdateFailureCauseTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCauseType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureCauseType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureCauseType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureCauseType->Notes" } ] } } }, "DeleteFailureCauseTypeResourceActionRequest": { "title": "DeleteFailureCauseTypeResourceActionRequest", "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 } } }, "BatchGetFailureCauseTypeResourceAction": { "title": "BatchGetFailureCauseTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Failure Cause Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Failure Cause Type entities", "items": { "$ref": "#/definitions/GetFailureCauseTypeResourceActionResponse" } }, "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" } } }, "BatchCreateFailureCauseTypeResourceActionRequest": { "title": "BatchCreateFailureCauseTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFailureCauseTypeResourceActionRequest" } }, "BatchUpdateFailureCauseTypeResourceActionRequest": { "title": "BatchUpdateFailureCauseTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFailureCauseTypeResourceActionRequest" } }, "BatchDeleteFailureCauseTypeResourceActionRequest": { "title": "BatchDeleteFailureCauseTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFailureCauseTypeResourceActionRequest" } }, "ChangeFailureCauseTypeIsActiveResourceActionRequest": { "title": "ChangeFailureCauseTypeIsActiveResourceActionRequest", "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": "FailureCauseType->IsActive" } ] } } }, "ChangeFailureCauseTypePermissionTreeResourceActionRequest": { "title": "ChangeFailureCauseTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureCauseType->PermissionTree_Id" } ] } } }, "BatchChangeFailureCauseTypeIsActiveResourceActionRequest": { "title": "BatchChangeFailureCauseTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureCauseTypeIsActiveResourceActionRequest" } }, "BatchChangeFailureCauseTypePermissionTreeResourceActionRequest": { "title": "BatchChangeFailureCauseTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureCauseTypePermissionTreeResourceActionRequest" } }, "GetFailureMechanismResourceActionResponse": { "title": "GetFailureMechanismResourceActionResponse", "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": "GetFailureMechanismResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FailureMechanism->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanism->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanism->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanism->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanism->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFailureMechanismCollectionResourceActionResponse": { "title": "GetFailureMechanismCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFailureMechanismCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFailureMechanismCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanism->SequenceNumber" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->PermissionTree_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanism->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanism->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" } } } }, "FailureMechanismChangePermissionTreeLookupResourceActionResponse": { "title": "FailureMechanismChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureMechanismChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureMechanismChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "FailureMechanismFailureMechanismTypeLookupResourceActionResponse": { "title": "FailureMechanismFailureMechanismTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureMechanismFailureMechanismTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureMechanismFailureMechanismTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FailureMechanismInsertPermissionTreeLookupResourceActionResponse": { "title": "FailureMechanismInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureMechanismInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureMechanismInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateFailureMechanismResourceActionRequest": { "title": "CreateFailureMechanismResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFailureMechanismResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "failureMechanismTypeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanism->PermissionTree_Id" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanism->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFailureMechanismResourceActionRequest": { "title": "UpdateFailureMechanismResourceActionRequest", "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": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanism->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanism->Notes" } ] } } }, "DeleteFailureMechanismResourceActionRequest": { "title": "DeleteFailureMechanismResourceActionRequest", "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 } } }, "BatchGetFailureMechanismResourceAction": { "title": "BatchGetFailureMechanismResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Failure Mechanism entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Failure Mechanism entities", "items": { "$ref": "#/definitions/GetFailureMechanismResourceActionResponse" } }, "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" } } }, "BatchCreateFailureMechanismResourceActionRequest": { "title": "BatchCreateFailureMechanismResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFailureMechanismResourceActionRequest" } }, "BatchUpdateFailureMechanismResourceActionRequest": { "title": "BatchUpdateFailureMechanismResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFailureMechanismResourceActionRequest" } }, "BatchDeleteFailureMechanismResourceActionRequest": { "title": "BatchDeleteFailureMechanismResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFailureMechanismResourceActionRequest" } }, "ChangeFailureMechanismIsActiveResourceActionRequest": { "title": "ChangeFailureMechanismIsActiveResourceActionRequest", "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": "FailureMechanism->IsActive" } ] } } }, "ChangeFailureMechanismPermissionTreeResourceActionRequest": { "title": "ChangeFailureMechanismPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanism->PermissionTree_Id" } ] } } }, "BatchChangeFailureMechanismIsActiveResourceActionRequest": { "title": "BatchChangeFailureMechanismIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureMechanismIsActiveResourceActionRequest" } }, "BatchChangeFailureMechanismPermissionTreeResourceActionRequest": { "title": "BatchChangeFailureMechanismPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureMechanismPermissionTreeResourceActionRequest" } }, "GetFailureMechanismTypeResourceActionResponse": { "title": "GetFailureMechanismTypeResourceActionResponse", "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": "GetFailureMechanismTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanismType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanismType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanismType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanismType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanismType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FailureMechanismType->IsActive" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanismType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFailureMechanismTypeCollectionResourceActionResponse": { "title": "GetFailureMechanismTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFailureMechanismTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFailureMechanismTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanismType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->Notes" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanismType->PermissionTree_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanismType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMechanismType->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" } } } }, "FailureMechanismTypeChangePermissionTreeLookupResourceActionResponse": { "title": "FailureMechanismTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureMechanismTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureMechanismTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "FailureMechanismTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "FailureMechanismTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureMechanismTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureMechanismTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateFailureMechanismTypeResourceActionRequest": { "title": "CreateFailureMechanismTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFailureMechanismTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanismType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanismType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanismType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFailureMechanismTypeResourceActionRequest": { "title": "UpdateFailureMechanismTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanismType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMechanismType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMechanismType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMechanismType->Notes" } ] } } }, "DeleteFailureMechanismTypeResourceActionRequest": { "title": "DeleteFailureMechanismTypeResourceActionRequest", "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 } } }, "BatchGetFailureMechanismTypeResourceAction": { "title": "BatchGetFailureMechanismTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Failure Mechanism Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Failure Mechanism Type entities", "items": { "$ref": "#/definitions/GetFailureMechanismTypeResourceActionResponse" } }, "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" } } }, "BatchCreateFailureMechanismTypeResourceActionRequest": { "title": "BatchCreateFailureMechanismTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFailureMechanismTypeResourceActionRequest" } }, "BatchUpdateFailureMechanismTypeResourceActionRequest": { "title": "BatchUpdateFailureMechanismTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFailureMechanismTypeResourceActionRequest" } }, "BatchDeleteFailureMechanismTypeResourceActionRequest": { "title": "BatchDeleteFailureMechanismTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFailureMechanismTypeResourceActionRequest" } }, "ChangeFailureMechanismTypeIsActiveResourceActionRequest": { "title": "ChangeFailureMechanismTypeIsActiveResourceActionRequest", "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": "FailureMechanismType->IsActive" } ] } } }, "ChangeFailureMechanismTypePermissionTreeResourceActionRequest": { "title": "ChangeFailureMechanismTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMechanismType->PermissionTree_Id" } ] } } }, "BatchChangeFailureMechanismTypeIsActiveResourceActionRequest": { "title": "BatchChangeFailureMechanismTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureMechanismTypeIsActiveResourceActionRequest" } }, "BatchChangeFailureMechanismTypePermissionTreeResourceActionRequest": { "title": "BatchChangeFailureMechanismTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureMechanismTypePermissionTreeResourceActionRequest" } }, "GetFailureModeResourceActionResponse": { "title": "GetFailureModeResourceActionResponse", "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": "GetFailureModeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FailureMode->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMode->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMode->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMode->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMode->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFailureModeCollectionResourceActionResponse": { "title": "GetFailureModeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFailureModeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFailureModeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->PermissionTree_Code" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMode->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMode->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureMode->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" } } } }, "FailureModeChangePermissionTreeLookupResourceActionResponse": { "title": "FailureModeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureModeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureModeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "FailureModeFailureModeTypeLookupResourceActionResponse": { "title": "FailureModeFailureModeTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureModeFailureModeTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureModeFailureModeTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "FailureModeInsertPermissionTreeLookupResourceActionResponse": { "title": "FailureModeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureModeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureModeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateFailureModeResourceActionRequest": { "title": "CreateFailureModeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFailureModeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "failureModeTypeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMode->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMode->SequenceNumber" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFailureModeResourceActionRequest": { "title": "UpdateFailureModeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureMode->SequenceNumber" }, { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureMode->Notes" } ] } } }, "DeleteFailureModeResourceActionRequest": { "title": "DeleteFailureModeResourceActionRequest", "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 } } }, "BatchGetFailureModeResourceAction": { "title": "BatchGetFailureModeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Failure Mode entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Failure Mode entities", "items": { "$ref": "#/definitions/GetFailureModeResourceActionResponse" } }, "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" } } }, "BatchCreateFailureModeResourceActionRequest": { "title": "BatchCreateFailureModeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFailureModeResourceActionRequest" } }, "BatchUpdateFailureModeResourceActionRequest": { "title": "BatchUpdateFailureModeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFailureModeResourceActionRequest" } }, "BatchDeleteFailureModeResourceActionRequest": { "title": "BatchDeleteFailureModeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFailureModeResourceActionRequest" } }, "ChangeFailureModeIsActiveResourceActionRequest": { "title": "ChangeFailureModeIsActiveResourceActionRequest", "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": "FailureMode->IsActive" } ] } } }, "ChangeFailureModePermissionTreeResourceActionRequest": { "title": "ChangeFailureModePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureMode->PermissionTree_Id" } ] } } }, "BatchChangeFailureModeIsActiveResourceActionRequest": { "title": "BatchChangeFailureModeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureModeIsActiveResourceActionRequest" } }, "BatchChangeFailureModePermissionTreeResourceActionRequest": { "title": "BatchChangeFailureModePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureModePermissionTreeResourceActionRequest" } }, "GetFailureModeTypeResourceActionResponse": { "title": "GetFailureModeTypeResourceActionResponse", "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": "GetFailureModeTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "FailureModeType->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureModeType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->PermissionTree_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureModeType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureModeType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureModeType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureModeType->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureModeType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetFailureModeTypeCollectionResourceActionResponse": { "title": "GetFailureModeTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetFailureModeTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetFailureModeTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureModeType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->Notes" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureModeType->PermissionTree_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureModeType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FailureModeType->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" } } } }, "FailureModeTypeChangePermissionTreeLookupResourceActionResponse": { "title": "FailureModeTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureModeTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureModeTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "FailureModeTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "FailureModeTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "FailureModeTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "FailureModeTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateFailureModeTypeResourceActionRequest": { "title": "CreateFailureModeTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateFailureModeTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureModeType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureModeType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureModeType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateFailureModeTypeResourceActionRequest": { "title": "UpdateFailureModeTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureModeType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "FailureModeType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FailureModeType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "FailureModeType->Notes" } ] } } }, "DeleteFailureModeTypeResourceActionRequest": { "title": "DeleteFailureModeTypeResourceActionRequest", "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 } } }, "BatchGetFailureModeTypeResourceAction": { "title": "BatchGetFailureModeTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Failure Mode Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Failure Mode Type entities", "items": { "$ref": "#/definitions/GetFailureModeTypeResourceActionResponse" } }, "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" } } }, "BatchCreateFailureModeTypeResourceActionRequest": { "title": "BatchCreateFailureModeTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateFailureModeTypeResourceActionRequest" } }, "BatchUpdateFailureModeTypeResourceActionRequest": { "title": "BatchUpdateFailureModeTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateFailureModeTypeResourceActionRequest" } }, "BatchDeleteFailureModeTypeResourceActionRequest": { "title": "BatchDeleteFailureModeTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteFailureModeTypeResourceActionRequest" } }, "ChangeFailureModeTypeIsActiveResourceActionRequest": { "title": "ChangeFailureModeTypeIsActiveResourceActionRequest", "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": "FailureModeType->IsActive" } ] } } }, "ChangeFailureModeTypePermissionTreeResourceActionRequest": { "title": "ChangeFailureModeTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "FailureModeType->PermissionTree_Id" } ] } } }, "BatchChangeFailureModeTypeIsActiveResourceActionRequest": { "title": "BatchChangeFailureModeTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureModeTypeIsActiveResourceActionRequest" } }, "BatchChangeFailureModeTypePermissionTreeResourceActionRequest": { "title": "BatchChangeFailureModeTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeFailureModeTypePermissionTreeResourceActionRequest" } }, "GetOptionResourceActionResponse": { "title": "GetOptionResourceActionResponse", "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": "GetOptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Option->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Option->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Option->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Option->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Option->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Option->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Option->ModifiedOn" }, "allowMultipleValues": { "title": "allowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "Option->AllowMultipleValues" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Option->DataType", "x-formatSpecifier": "OptionDataType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Option->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Option->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Option->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Description" }, "lowerBounds": { "title": "lowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Option->Notes" }, "optionCategoryId": { "title": "optionCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Id" }, "optionCategoryCode": { "title": "optionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "Option->OptionCategory_Code" }, "optionCategoryDescription": { "title": "optionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Option->OptionCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Option->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Description" }, "upperBounds": { "title": "upperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" } } }, "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" } } }, "GetOptionCollectionResourceActionResponse": { "title": "GetOptionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetOptionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetOptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Option->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Option->Notes" }, "optionCategoryCode": { "title": "optionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Code" }, "optionCategoryDescription": { "title": "optionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Option->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Option->ModifiedOn" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Option->DataType", "x-formatSpecifier": "OptionDataType" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Option->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Option->UnitOfMeasurement_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "OptionChangePermissionTreeLookupResourceActionResponse": { "title": "OptionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "OptionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "OptionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "OptionInsertPermissionTreeLookupResourceActionResponse": { "title": "OptionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "OptionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "OptionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "OptionOptionCategoryLookupResourceActionResponse": { "title": "OptionOptionCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "OptionOptionCategoryLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "OptionOptionCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OptionCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OptionCategory->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" } } } }, "OptionUnitOfMeasurementLookupResourceActionResponse": { "title": "OptionUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "OptionUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "OptionUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateOptionResourceActionRequest": { "title": "CreateOptionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateOptionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "optionCategoryId", "dataType", "allowMultipleValues" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Option->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Option->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Option->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Option->SequenceNumber" }, "optionCategoryId": { "title": "optionCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Id" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Option->DataType", "x-formatSpecifier": "OptionDataType" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Id" }, "lowerBounds": { "title": "lowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "upperBounds": { "title": "upperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "allowMultipleValues": { "title": "allowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "Option->AllowMultipleValues" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Option->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateOptionResourceActionRequest": { "title": "UpdateOptionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Option->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Option->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Option->SequenceNumber" }, { "title": "optionCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Id" }, { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Option->DataType", "x-formatSpecifier": "OptionDataType" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Id" }, { "title": "lowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, { "title": "upperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, { "title": "allowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "Option->AllowMultipleValues" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Option->Notes" } ] } } }, "DeleteOptionResourceActionRequest": { "title": "DeleteOptionResourceActionRequest", "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 } } }, "BatchGetOptionResourceAction": { "title": "BatchGetOptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Option entities", "items": { "$ref": "#/definitions/GetOptionResourceActionResponse" } }, "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" } } }, "BatchCreateOptionResourceActionRequest": { "title": "BatchCreateOptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateOptionResourceActionRequest" } }, "BatchUpdateOptionResourceActionRequest": { "title": "BatchUpdateOptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateOptionResourceActionRequest" } }, "BatchDeleteOptionResourceActionRequest": { "title": "BatchDeleteOptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteOptionResourceActionRequest" } }, "ChangeOptionIsActiveResourceActionRequest": { "title": "ChangeOptionIsActiveResourceActionRequest", "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": "Option->IsActive" } ] } } }, "ChangeOptionPermissionTreeResourceActionRequest": { "title": "ChangeOptionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Option->PermissionTree_Id" } ] } } }, "BatchChangeOptionIsActiveResourceActionRequest": { "title": "BatchChangeOptionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeOptionIsActiveResourceActionRequest" } }, "BatchChangeOptionPermissionTreeResourceActionRequest": { "title": "BatchChangeOptionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeOptionPermissionTreeResourceActionRequest" } }, "GetOptionCategoryResourceActionResponse": { "title": "GetOptionCategoryResourceActionResponse", "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": "GetOptionCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OptionCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OptionCategory->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OptionCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OptionCategory->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OptionCategory->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->PermissionTree_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OptionCategory->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "OptionCategory->IsActive" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OptionCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OptionCategory->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetOptionCategoryCollectionResourceActionResponse": { "title": "GetOptionCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetOptionCategoryCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetOptionCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OptionCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OptionCategory->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OptionCategory->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OptionCategory->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OptionCategory->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" } } } }, "OptionCategoryChangePermissionTreeLookupResourceActionResponse": { "title": "OptionCategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "OptionCategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "OptionCategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "OptionCategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "OptionCategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "OptionCategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "OptionCategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateOptionCategoryResourceActionRequest": { "title": "CreateOptionCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateOptionCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OptionCategory->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "OptionCategory->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "OptionCategory->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OptionCategory->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateOptionCategoryResourceActionRequest": { "title": "UpdateOptionCategoryResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "OptionCategory->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "OptionCategory->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OptionCategory->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OptionCategory->Notes" } ] } } }, "DeleteOptionCategoryResourceActionRequest": { "title": "DeleteOptionCategoryResourceActionRequest", "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 } } }, "BatchGetOptionCategoryResourceAction": { "title": "BatchGetOptionCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Option Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Option Category entities", "items": { "$ref": "#/definitions/GetOptionCategoryResourceActionResponse" } }, "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" } } }, "BatchCreateOptionCategoryResourceActionRequest": { "title": "BatchCreateOptionCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateOptionCategoryResourceActionRequest" } }, "BatchUpdateOptionCategoryResourceActionRequest": { "title": "BatchUpdateOptionCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateOptionCategoryResourceActionRequest" } }, "BatchDeleteOptionCategoryResourceActionRequest": { "title": "BatchDeleteOptionCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteOptionCategoryResourceActionRequest" } }, "ChangeOptionCategoryIsActiveResourceActionRequest": { "title": "ChangeOptionCategoryIsActiveResourceActionRequest", "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": "OptionCategory->IsActive" } ] } } }, "ChangeOptionCategoryPermissionTreeResourceActionRequest": { "title": "ChangeOptionCategoryPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OptionCategory->PermissionTree_Id" } ] } } }, "BatchChangeOptionCategoryIsActiveResourceActionRequest": { "title": "BatchChangeOptionCategoryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeOptionCategoryIsActiveResourceActionRequest" } }, "BatchChangeOptionCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeOptionCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeOptionCategoryPermissionTreeResourceActionRequest" } }, "GetRepairTypeResourceActionResponse": { "title": "GetRepairTypeResourceActionResponse", "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": "GetRepairTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RepairType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RepairType->CreatedOn" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RepairType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RepairType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RepairType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RepairType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RepairType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRepairTypeCollectionResourceActionResponse": { "title": "GetRepairTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRepairTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRepairTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->PermissionTree_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RepairType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RepairType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RepairType->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" } } } }, "RepairTypeChangePermissionTreeLookupResourceActionResponse": { "title": "RepairTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RepairTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RepairTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RepairTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "RepairTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RepairTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RepairTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRepairTypeResourceActionRequest": { "title": "CreateRepairTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRepairTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RepairType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RepairType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RepairType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RepairType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRepairTypeResourceActionRequest": { "title": "UpdateRepairTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RepairType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RepairType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RepairType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RepairType->Notes" } ] } } }, "DeleteRepairTypeResourceActionRequest": { "title": "DeleteRepairTypeResourceActionRequest", "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 } } }, "BatchGetRepairTypeResourceAction": { "title": "BatchGetRepairTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Repair Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Repair Type entities", "items": { "$ref": "#/definitions/GetRepairTypeResourceActionResponse" } }, "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" } } }, "BatchCreateRepairTypeResourceActionRequest": { "title": "BatchCreateRepairTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRepairTypeResourceActionRequest" } }, "BatchUpdateRepairTypeResourceActionRequest": { "title": "BatchUpdateRepairTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRepairTypeResourceActionRequest" } }, "BatchDeleteRepairTypeResourceActionRequest": { "title": "BatchDeleteRepairTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRepairTypeResourceActionRequest" } }, "ChangeRepairTypeIsActiveResourceActionRequest": { "title": "ChangeRepairTypeIsActiveResourceActionRequest", "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": "RepairType->IsActive" } ] } } }, "ChangeRepairTypePermissionTreeResourceActionRequest": { "title": "ChangeRepairTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RepairType->PermissionTree_Id" } ] } } }, "BatchChangeRepairTypeIsActiveResourceActionRequest": { "title": "BatchChangeRepairTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRepairTypeIsActiveResourceActionRequest" } }, "BatchChangeRepairTypePermissionTreeResourceActionRequest": { "title": "BatchChangeRepairTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRepairTypePermissionTreeResourceActionRequest" } }, "GetRuleResourceActionResponse": { "title": "GetRuleResourceActionResponse", "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": "GetRuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Rule->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Rule->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Rule->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Rule->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Rule->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Rule->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->Notes" }, "ruleCategoryId": { "title": "ruleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Rule->RuleCategory_Id" }, "ruleCategoryCode": { "title": "ruleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->RuleCategory_Code" }, "ruleCategoryDescription": { "title": "ruleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->RuleCategory_Description" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Rule->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRuleCollectionResourceActionResponse": { "title": "GetRuleCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->PermissionTree_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Rule->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->Notes" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "ruleCategoryId": { "title": "ruleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Rule->RuleCategory_Id" }, "ruleCategoryCode": { "title": "ruleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleCategory_Code" }, "ruleCategoryDescription": { "title": "ruleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleCategory_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Rule->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Rule->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" } } } }, "GetRuleForRuleCategoryCollectionResourceActionResponse": { "title": "GetRuleForRuleCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleForRuleCategoryCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleForRuleCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->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" } } } }, "RuleChangePermissionTreeLookupResourceActionResponse": { "title": "RuleChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RuleChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RuleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RuleInsertPermissionTreeLookupResourceActionResponse": { "title": "RuleInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RuleInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RuleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RuleRuleCategoryLookupResourceActionResponse": { "title": "RuleRuleCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RuleRuleCategoryLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RuleRuleCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->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" } } } }, "CreateRuleResourceActionRequest": { "title": "CreateRuleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRuleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "ruleText" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Rule->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Rule->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Rule->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Rule->SequenceNumber" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "ruleCategoryId": { "title": "ruleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Rule->RuleCategory_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRuleResourceActionRequest": { "title": "UpdateRuleResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Rule->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Rule->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Rule->SequenceNumber" }, { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, { "title": "ruleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Rule->RuleCategory_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Rule->Notes" } ] } } }, "DeleteRuleResourceActionRequest": { "title": "DeleteRuleResourceActionRequest", "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 } } }, "BatchGetRuleResourceAction": { "title": "BatchGetRuleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Rule entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Rule entities", "items": { "$ref": "#/definitions/GetRuleResourceActionResponse" } }, "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" } } }, "BatchCreateRuleResourceActionRequest": { "title": "BatchCreateRuleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRuleResourceActionRequest" } }, "BatchUpdateRuleResourceActionRequest": { "title": "BatchUpdateRuleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRuleResourceActionRequest" } }, "BatchDeleteRuleResourceActionRequest": { "title": "BatchDeleteRuleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRuleResourceActionRequest" } }, "ChangeRuleIsActiveResourceActionRequest": { "title": "ChangeRuleIsActiveResourceActionRequest", "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": "Rule->IsActive" } ] } } }, "ChangeRulePermissionTreeResourceActionRequest": { "title": "ChangeRulePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Rule->PermissionTree_Id" } ] } } }, "BatchChangeRuleIsActiveResourceActionRequest": { "title": "BatchChangeRuleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRuleIsActiveResourceActionRequest" } }, "BatchChangeRulePermissionTreeResourceActionRequest": { "title": "BatchChangeRulePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRulePermissionTreeResourceActionRequest" } }, "GetRuleCategoryResourceActionResponse": { "title": "GetRuleCategoryResourceActionResponse", "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": "GetRuleCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleCategory->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RuleCategory->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleCategory->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RuleCategory->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RuleCategory->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRuleCategoryCollectionResourceActionResponse": { "title": "GetRuleCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleCategoryCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleCategory->PermissionTree_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RuleCategory->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleCategory->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleCategory->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" } } } }, "RuleCategoryChangePermissionTreeLookupResourceActionResponse": { "title": "RuleCategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RuleCategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RuleCategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RuleCategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "RuleCategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RuleCategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RuleCategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRuleCategoryResourceActionRequest": { "title": "CreateRuleCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRuleCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RuleCategory->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RuleCategory->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RuleCategory->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RuleCategory->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRuleCategoryResourceActionRequest": { "title": "UpdateRuleCategoryResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RuleCategory->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RuleCategory->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RuleCategory->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RuleCategory->Notes" } ] } } }, "DeleteRuleCategoryResourceActionRequest": { "title": "DeleteRuleCategoryResourceActionRequest", "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 } } }, "BatchGetRuleCategoryResourceAction": { "title": "BatchGetRuleCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Rule Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Rule Category entities", "items": { "$ref": "#/definitions/GetRuleCategoryResourceActionResponse" } }, "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" } } }, "BatchCreateRuleCategoryResourceActionRequest": { "title": "BatchCreateRuleCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRuleCategoryResourceActionRequest" } }, "BatchUpdateRuleCategoryResourceActionRequest": { "title": "BatchUpdateRuleCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRuleCategoryResourceActionRequest" } }, "BatchDeleteRuleCategoryResourceActionRequest": { "title": "BatchDeleteRuleCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRuleCategoryResourceActionRequest" } }, "ChangeRuleCategoryIsActiveResourceActionRequest": { "title": "ChangeRuleCategoryIsActiveResourceActionRequest", "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": "RuleCategory->IsActive" } ] } } }, "ChangeRuleCategoryPermissionTreeResourceActionRequest": { "title": "ChangeRuleCategoryPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RuleCategory->PermissionTree_Id" } ] } } }, "BatchChangeRuleCategoryIsActiveResourceActionRequest": { "title": "BatchChangeRuleCategoryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRuleCategoryIsActiveResourceActionRequest" } }, "BatchChangeRuleCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeRuleCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRuleCategoryPermissionTreeResourceActionRequest" } }, "GetRuleOptionResourceActionResponse": { "title": "GetRuleOptionResourceActionResponse", "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": "GetRuleOptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleOption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleOption->ModifiedOn" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RuleOption->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Option_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RuleOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionOptionCategoryId": { "title": "optionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->Option_OptionCategory_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Option_OptionCategory_Description" }, "optionUnitOfMeasurementId": { "title": "optionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->Option_UnitOfMeasurement_Id" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Option_UnitOfMeasurement_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RuleOption->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_RuleCategory_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" } } }, "GetRuleOptionCollectionResourceActionResponse": { "title": "GetRuleOptionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleOptionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleOptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Rule_Description" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Rule_RuleCategory_Description" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_Description" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_OptionCategory_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RuleOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_UnitOfMeasurement_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleOption->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RuleOption->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" } } } }, "GetRuleOptionForRuleCollectionResourceActionResponse": { "title": "GetRuleOptionForRuleCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleOptionForRuleCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleOptionForRuleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RuleOption->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_Description" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_OptionCategory_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RuleOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RuleOption->Option_UnitOfMeasurement_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BatchGetRuleOptionResourceAction": { "title": "BatchGetRuleOptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Rule Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Rule Option entities", "items": { "$ref": "#/definitions/GetRuleOptionResourceActionResponse" } }, "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" } } }, "GetStandardTaskResourceActionResponse": { "title": "GetStandardTaskResourceActionResponse", "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": "GetStandardTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTask->SequenceNumber" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->AlternativeDescription" }, "autoCalculateDowntimePerUnit": { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateDowntimePerUnit" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateTotalDowntime" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateTotalDuration" }, "daysToScheduleOn": { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval1_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval2_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->DefaultInterval2_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->DurationPerUnit" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Event_Description" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->FailedReasonRequired", "x-NullExpression": "StandardTask->InspectionType eq 'PassOrFail'" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Importance_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->InheritedFrom_Id" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->InspectionType", "x-formatSpecifier": "InspectionType" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType1_Code" }, "intervalType1SchedulingKind": { "title": "intervalType1SchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType1_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType2_Description" }, "intervalType2SchedulingKind": { "title": "intervalType2SchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType2_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsDualScheduling" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsMandatory" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsStatutory" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsSuppressed" }, "isSuppressor": { "title": "isSuppressor", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsSuppressor" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "longDescription": { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->LongDescription" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->MachineState", "x-formatSpecifier": "MachineState" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Notes" }, "printLongDescriptionOnWorkOrder": { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->PrintLongDescriptionOnWorkOrder" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceResourceType": { "title": "responsibleStaffMemberResourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_ResourceType", "x-formatSpecifier": "ResourceType" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleTrade_Description" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification8_Description" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TaskRollUpPoint_Description" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->TypeOfWork_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" } } }, "GetStandardTaskCollectionResourceActionResponse": { "title": "GetStandardTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskCollectionResourceActionResponseItemProperties", "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" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTask->SequenceNumber" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsMandatory" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->Importance_Code" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskChangePermissionTreeLookupResourceActionResponse": { "title": "StandardTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskDefaultInterval1LookupResourceActionResponse": { "title": "StandardTaskDefaultInterval1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskDefaultInterval1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskDefaultInterval1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->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" } } } }, "StandardTaskDefaultInterval2LookupResourceActionResponse": { "title": "StandardTaskDefaultInterval2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskDefaultInterval2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskDefaultInterval2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->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" } } } }, "StandardTaskEventLookupResourceActionResponse": { "title": "StandardTaskEventLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskEventLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskEventLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Event->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskForAssetRegisterLookupResourceActionResponse": { "title": "StandardTaskForAssetRegisterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskForAssetRegisterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskForAssetRegisterLookupResourceActionResponseItemProperties", "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" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->InspectionType", "x-formatSpecifier": "InspectionType" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Description" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskForAssetTypeRegisterLookupResourceActionResponse": { "title": "StandardTaskForAssetTypeRegisterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskForAssetTypeRegisterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskForAssetTypeRegisterLookupResourceActionResponseItemProperties", "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" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->InspectionType", "x-formatSpecifier": "InspectionType" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Description" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskImportanceLookupResourceActionResponse": { "title": "StandardTaskImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->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" } } } }, "StandardTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "StandardTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskIntervalType1LookupResourceActionResponse": { "title": "StandardTaskIntervalType1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskIntervalType1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskIntervalType1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TaskIntervalType->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskIntervalType2LookupResourceActionResponse": { "title": "StandardTaskIntervalType2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskIntervalType2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskIntervalType2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TaskIntervalType->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResponsibleSectionLookupResourceActionResponse": { "title": "StandardTaskResponsibleSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResponsibleSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResponsibleSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResponsibleStaffMemberResourceLookupResourceActionResponse": { "title": "StandardTaskResponsibleStaffMemberResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResponsibleStaffMemberResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResponsibleStaffMemberResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResponsibleTradeLookupResourceActionResponse": { "title": "StandardTaskResponsibleTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResponsibleTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResponsibleTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification1LookupResourceActionResponse": { "title": "StandardTaskTaskClassification1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification1LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification2LookupResourceActionResponse": { "title": "StandardTaskTaskClassification2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification2LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification3LookupResourceActionResponse": { "title": "StandardTaskTaskClassification3LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification3LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification3LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification4LookupResourceActionResponse": { "title": "StandardTaskTaskClassification4LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification4LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification4LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification5LookupResourceActionResponse": { "title": "StandardTaskTaskClassification5LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification5LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification5LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification6LookupResourceActionResponse": { "title": "StandardTaskTaskClassification6LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification6LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification6LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification7LookupResourceActionResponse": { "title": "StandardTaskTaskClassification7LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification7LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification7LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskClassification8LookupResourceActionResponse": { "title": "StandardTaskTaskClassification8LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskClassification8LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskClassification8LookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskTaskRollUpPointLookupResourceActionResponse": { "title": "StandardTaskTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTaskRollUpPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->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" } } } }, "StandardTaskTypeOfWorkLookupResourceActionResponse": { "title": "StandardTaskTypeOfWorkLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskTypeOfWorkLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskTypeOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateStandardTaskResourceActionRequest": { "title": "CreateStandardTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateStandardTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description", "importanceId", "intervalType1Id", "isDualScheduling", "isInspection", "isMandatory", "isStatutory", "labourDurationCalculationType", "permissionTreeId", "typeOfWorkId" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTask->AlternativeDescription" }, "autoCalculateDowntimePerUnit": { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateDowntimePerUnit" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateTotalDowntime" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateTotalDuration" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTask->Code", "x-systemGenerated": true }, "daysToScheduleOn": { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval1_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval2_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->DurationPerUnit" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->Event_Id" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->FailedReasonRequired", "x-NullExpression": "StandardTask->InspectionType eq 'PassOrFail'" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->Importance_Id" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Id" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsDualScheduling" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsInspection" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->InspectionType", "x-formatSpecifier": "InspectionType" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsMandatory" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsStatutory" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "longDescription": { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->LongDescription" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->MachineState", "x-formatSpecifier": "MachineState" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->PermissionTree_Id" }, "printLongDescriptionOnWorkOrder": { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->PrintLongDescriptionOnWorkOrder" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_Id" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleSection_Id" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleTrade_Id" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTask->SequenceNumber" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification1_Id" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification2_Id" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification3_Id" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification4_Id" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification5_Id" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification6_Id" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification7_Id" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification8_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskRollUpPoint_Id" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->TypeOfWork_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateStandardTaskResourceActionRequest": { "title": "UpdateStandardTaskResourceActionRequest", "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": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTask->AlternativeDescription" }, { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateDowntimePerUnit" }, { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateDurationPerUnit" }, { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateTotalDowntime" }, { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->AutoCalculateTotalDuration" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTask->Code" }, { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval1_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->DefaultInterval2_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTask->Description" }, { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->DowntimePerUnit" }, { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->DurationPerUnit" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->Event_Id" }, { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->FailedReasonRequired", "x-NullExpression": "StandardTask->InspectionType eq 'PassOrFail'" }, { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->Importance_Id" }, { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType1_Id" }, { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->IntervalType2_Id", "x-NullExpression": "StandardTask->IsDualScheduling eq true" }, { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsDualScheduling" }, { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->IsInspection" }, { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->InspectionType", "x-formatSpecifier": "InspectionType" }, { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsMandatory" }, { "title": "isStatutory", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTask->IsStatutory" }, { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->LongDescription" }, { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTask->MachineState", "x-formatSpecifier": "MachineState" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTask->Notes" }, { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTask->PrintLongDescriptionOnWorkOrder" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleSection_Id" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->ResponsibleTrade_Id" }, { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTask->SequenceNumber" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskClassification8_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTask->TaskRollUpPoint_Id" }, { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->TotalDowntime" }, { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "StandardTask->TotalDuration" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTask->TypeOfWork_Id" } ] } } }, "BatchGetStandardTaskResourceAction": { "title": "BatchGetStandardTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Standard Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Standard Task entities", "items": { "$ref": "#/definitions/GetStandardTaskResourceActionResponse" } }, "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" } } }, "BatchCreateStandardTaskResourceActionRequest": { "title": "BatchCreateStandardTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateStandardTaskResourceActionRequest" } }, "BatchUpdateStandardTaskResourceActionRequest": { "title": "BatchUpdateStandardTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateStandardTaskResourceActionRequest" } }, "ChangeStandardTaskIsActiveResourceActionRequest": { "title": "ChangeStandardTaskIsActiveResourceActionRequest", "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": "StandardTask->IsActive" } ] } } }, "BatchChangeStandardTaskIsActiveResourceActionRequest": { "title": "BatchChangeStandardTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskIsActiveResourceActionRequest" } }, "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" } } }, "GetStandardTaskResourceResourceActionResponse": { "title": "GetStandardTaskResourceResourceActionResponse", "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": "GetStandardTaskResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskResource->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskResource->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskResource->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskResource->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskResource->SequenceNumber" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Proficiency", "x-NullExpression": "StandardTaskResource->Competency_Id ne NULL" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_Id", "x-NullExpression": "StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_Code" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Description" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->StandardTask_Description" }, "standardTaskLastConfirmedOn": { "title": "standardTaskLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskResource->StandardTask_LastConfirmedOn" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Trade_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->UnitOfMeasurement_Description" }, "unitOfMeasurementMeasurementType": { "title": "unitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->UnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskResource->Usage", "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" } } }, "GetResourceForStandardTaskCollectionResourceActionResponse": { "title": "GetResourceForStandardTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetResourceForStandardTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetResourceForStandardTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Competency_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Trade_Description" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Section_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_Code" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailLastName" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->StandardTask_Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Proficiency", "x-NullExpression": "StandardTaskResource->Competency_Id ne NULL" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetStandardTaskResourceCollectionResourceActionResponse": { "title": "GetStandardTaskResourceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskResourceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Competency_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Trade_Description" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Section_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_Code" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Resource_ContactDetailLastName" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskResource->StandardTask_Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Proficiency", "x-NullExpression": "StandardTaskResource->Competency_Id ne NULL" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResourceChangePermissionTreeLookupResourceActionResponse": { "title": "StandardTaskResourceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskResourceCompetencyLookupResourceActionResponse": { "title": "StandardTaskResourceCompetencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceCompetencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceCompetencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Competency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Competency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "StandardTaskResourceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskResourceResourceLookupResourceActionResponse": { "title": "StandardTaskResourceResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResourceSectionLookupResourceActionResponse": { "title": "StandardTaskResourceSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResourceStandardTaskLookupResourceActionResponse": { "title": "StandardTaskResourceStandardTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceStandardTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceStandardTaskLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "StandardTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResourceTradeLookupResourceActionResponse": { "title": "StandardTaskResourceTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskResourceUnitOfMeasurementLookupResourceActionResponse": { "title": "StandardTaskResourceUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskResourceUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskResourceUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateStandardTaskResourceResourceActionRequest": { "title": "CreateStandardTaskResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateStandardTaskResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "standardTaskId", "quantity", "tradeId" ], "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskResource->StandardTask_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Id" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskResource->Usage", "x-systemGenerated": true, "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->PermissionTree_Id", "x-systemGenerated": true }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Proficiency", "x-NullExpression": "StandardTaskResource->Competency_Id ne NULL" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskResource->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_Id", "x-NullExpression": "StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskResource->ResourceType", "x-systemGenerated": true, "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Trade_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateStandardTaskResourceResourceActionRequest": { "title": "UpdateStandardTaskResourceResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Notes" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Resource_Id", "x-NullExpression": "StandardTaskResource->Trade_Id eq NULL AND StandardTaskResource->Section_Id eq NULL" }, { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskResource->Competency_Id" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Proficiency", "x-NullExpression": "StandardTaskResource->Competency_Id ne NULL" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "StandardTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskResource->Quantity" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskResource->UnitOfMeasurement_Id" } ] } } }, "BatchGetStandardTaskResourceResourceAction": { "title": "BatchGetStandardTaskResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Standard Task Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Standard Task Resource entities", "items": { "$ref": "#/definitions/GetStandardTaskResourceResourceActionResponse" } }, "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" } } }, "BatchCreateStandardTaskResourceResourceActionRequest": { "title": "BatchCreateStandardTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateStandardTaskResourceResourceActionRequest" } }, "BatchUpdateStandardTaskResourceResourceActionRequest": { "title": "BatchUpdateStandardTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateStandardTaskResourceResourceActionRequest" } }, "ChangeStandardTaskResourceIsActiveResourceActionRequest": { "title": "ChangeStandardTaskResourceIsActiveResourceActionRequest", "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": "StandardTaskResource->IsActive" } ] } } }, "BatchChangeStandardTaskResourceIsActiveResourceActionRequest": { "title": "BatchChangeStandardTaskResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskResourceIsActiveResourceActionRequest" } }, "GetStandardTaskSpareResourceActionResponse": { "title": "GetStandardTaskSpareResourceActionResponse", "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": "GetStandardTaskSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskSpare->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->SequenceNumber" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->InheritedFrom_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->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" } } }, "GetSpareForStandardTaskCollectionResourceActionResponse": { "title": "GetSpareForStandardTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForStandardTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForStandardTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->Quantity" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetStandardTaskSpareCollectionResourceActionResponse": { "title": "GetStandardTaskSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->CostElement_Description" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->StandardTask_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->Quantity" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskSpareChangePermissionTreeLookupResourceActionResponse": { "title": "StandardTaskSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskSpareCommodityLookupResourceActionResponse": { "title": "StandardTaskSpareCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSpareCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSpareCommodityLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Commodity->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Commodity->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" } } } }, "StandardTaskSpareCostElementLookupResourceActionResponse": { "title": "StandardTaskSpareCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSpareCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSpareCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "StandardTaskSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskSpareMaterialMasterLookupResourceActionResponse": { "title": "StandardTaskSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSpareMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->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" } } } }, "StandardTaskSpareTaskStandardTaskLookupResourceActionResponse": { "title": "StandardTaskSpareTaskStandardTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSpareTaskStandardTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSpareTaskStandardTaskLookupResourceActionResponseItemProperties", "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" } } } }, "CreateStandardTaskSpareResourceActionRequest": { "title": "CreateStandardTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateStandardTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "standardTaskId", "materialMasterId" ], "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskSpare->StandardTask_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->MaterialMaster_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSpare->PermissionTree_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskSpare->Quantity" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateStandardTaskSpareResourceActionRequest": { "title": "UpdateStandardTaskSpareResourceActionRequest", "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": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->CostElement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->Notes" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskSpare->Quantity" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSpare->SequenceNumber" } ] } } }, "BatchGetStandardTaskSpareResourceAction": { "title": "BatchGetStandardTaskSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Standard Task Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Standard Task Spare entities", "items": { "$ref": "#/definitions/GetStandardTaskSpareResourceActionResponse" } }, "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" } } }, "BatchCreateStandardTaskSpareResourceActionRequest": { "title": "BatchCreateStandardTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateStandardTaskSpareResourceActionRequest" } }, "BatchUpdateStandardTaskSpareResourceActionRequest": { "title": "BatchUpdateStandardTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateStandardTaskSpareResourceActionRequest" } }, "ChangeStandardTaskSpareIsActiveResourceActionRequest": { "title": "ChangeStandardTaskSpareIsActiveResourceActionRequest", "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": "StandardTaskSpare->IsActive" } ] } } }, "BatchChangeStandardTaskSpareIsActiveResourceActionRequest": { "title": "BatchChangeStandardTaskSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskSpareIsActiveResourceActionRequest" } }, "GetStandardTaskSubTaskResourceActionResponse": { "title": "GetStandardTaskSubTaskResourceActionResponse", "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": "GetStandardTaskSubTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskSubTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskSubTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskSubTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->SequenceNumber" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->AlternativeDescription" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->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" } } }, "GetStandardTaskSubTaskCollectionResourceActionResponse": { "title": "GetStandardTaskSubTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskSubTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskSubTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->StandardTask_Description" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->AlternativeDescription" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->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" } } } }, "GetSubTaskForStandardTaskCollectionResourceActionResponse": { "title": "GetSubTaskForStandardTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSubTaskForStandardTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSubTaskForStandardTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->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" } } } }, "StandardTaskSubTaskChangePermissionTreeLookupResourceActionResponse": { "title": "StandardTaskSubTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSubTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSubTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskSubTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "StandardTaskSubTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskSubTaskTaskStandardTaskLookupResourceActionResponse": { "title": "StandardTaskSubTaskTaskStandardTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskSubTaskTaskStandardTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskSubTaskTaskStandardTaskLookupResourceActionResponseItemProperties", "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" } } } }, "CreateStandardTaskSubTaskResourceActionRequest": { "title": "CreateStandardTaskSubTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateStandardTaskSubTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "standardTaskId", "description", "alternativeDescription" ], "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "StandardTaskSubTask->StandardTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->AlternativeDescription" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateStandardTaskSubTaskResourceActionRequest": { "title": "UpdateStandardTaskSubTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Notes" }, { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->Code" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "StandardTaskSubTask->AlternativeDescription" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskSubTask->SequenceNumber" } ] } } }, "BatchGetStandardTaskSubTaskResourceAction": { "title": "BatchGetStandardTaskSubTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Standard Task Sub Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Standard Task Sub Task entities", "items": { "$ref": "#/definitions/GetStandardTaskSubTaskResourceActionResponse" } }, "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" } } }, "BatchCreateStandardTaskSubTaskResourceActionRequest": { "title": "BatchCreateStandardTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateStandardTaskSubTaskResourceActionRequest" } }, "BatchUpdateStandardTaskSubTaskResourceActionRequest": { "title": "BatchUpdateStandardTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateStandardTaskSubTaskResourceActionRequest" } }, "ChangeStandardTaskSubTaskIsActiveResourceActionRequest": { "title": "ChangeStandardTaskSubTaskIsActiveResourceActionRequest", "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": "StandardTaskSubTask->IsActive" } ] } } }, "BatchChangeStandardTaskSubTaskIsActiveResourceActionRequest": { "title": "BatchChangeStandardTaskSubTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskSubTaskIsActiveResourceActionRequest" } }, "GetTaskImportanceResourceActionResponse": { "title": "GetTaskImportanceResourceActionResponse", "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": "GetTaskImportanceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskImportance->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskImportance->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TaskImportance->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskImportance->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskImportance->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskImportance->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->Notes" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskImportance->Weight" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskImportance->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetTaskImportanceCollectionResourceActionResponse": { "title": "GetTaskImportanceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTaskImportanceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTaskImportanceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->Description" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskImportance->Weight" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskImportance->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskImportance->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskImportance->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" } } } }, "TaskImportanceChangePermissionTreeLookupResourceActionResponse": { "title": "TaskImportanceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskImportanceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskImportanceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TaskImportanceInsertPermissionTreeLookupResourceActionResponse": { "title": "TaskImportanceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskImportanceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskImportanceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateTaskImportanceResourceActionRequest": { "title": "CreateTaskImportanceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTaskImportanceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "weight" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskImportance->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskImportance->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskImportance->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskImportance->SequenceNumber" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskImportance->Weight" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTaskImportanceResourceActionRequest": { "title": "UpdateTaskImportanceResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskImportance->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskImportance->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskImportance->SequenceNumber" }, { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskImportance->Weight" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskImportance->Notes" } ] } } }, "DeleteTaskImportanceResourceActionRequest": { "title": "DeleteTaskImportanceResourceActionRequest", "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 } } }, "BatchGetTaskImportanceResourceAction": { "title": "BatchGetTaskImportanceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Task Importance entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Task Importance entities", "items": { "$ref": "#/definitions/GetTaskImportanceResourceActionResponse" } }, "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" } } }, "BatchCreateTaskImportanceResourceActionRequest": { "title": "BatchCreateTaskImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTaskImportanceResourceActionRequest" } }, "BatchUpdateTaskImportanceResourceActionRequest": { "title": "BatchUpdateTaskImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTaskImportanceResourceActionRequest" } }, "BatchDeleteTaskImportanceResourceActionRequest": { "title": "BatchDeleteTaskImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTaskImportanceResourceActionRequest" } }, "ChangeTaskImportanceIsActiveResourceActionRequest": { "title": "ChangeTaskImportanceIsActiveResourceActionRequest", "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": "TaskImportance->IsActive" } ] } } }, "ChangeTaskImportancePermissionTreeResourceActionRequest": { "title": "ChangeTaskImportancePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskImportance->PermissionTree_Id" } ] } } }, "BatchChangeTaskImportanceIsActiveResourceActionRequest": { "title": "BatchChangeTaskImportanceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskImportanceIsActiveResourceActionRequest" } }, "BatchChangeTaskImportancePermissionTreeResourceActionRequest": { "title": "BatchChangeTaskImportancePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskImportancePermissionTreeResourceActionRequest" } }, "GetTaskIntervalResourceActionResponse": { "title": "GetTaskIntervalResourceActionResponse", "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": "GetTaskIntervalResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TaskInterval->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskInterval->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskInterval->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskInterval->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskInterval->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskInterval->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->Description" }, "interval": { "title": "interval", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskInterval->Interval" }, "measurementTypeInterval": { "title": "measurementTypeInterval", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskInterval->MeasurementTypeInterval" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskInterval->SequenceNumber" }, "taskIntervalTypeId": { "title": "taskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_Id" }, "taskIntervalTypeCode": { "title": "taskIntervalTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->TaskIntervalType_Code" }, "taskIntervalTypeDescription": { "title": "taskIntervalTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->TaskIntervalType_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" } } }, "GetTaskIntervalCollectionResourceActionResponse": { "title": "GetTaskIntervalCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTaskIntervalCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTaskIntervalCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskInterval->SequenceNumber" }, "interval": { "title": "interval", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskInterval->Interval" }, "taskIntervalTypeId": { "title": "taskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskInterval->TaskIntervalType_Id" }, "taskIntervalTypeCode": { "title": "taskIntervalTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_Code" }, "taskIntervalTypeDescription": { "title": "taskIntervalTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_Description" }, "taskIntervalTypeUnitOfMeasurementId": { "title": "taskIntervalTypeUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskInterval->TaskIntervalType_UnitOfMeasurement_Id" }, "taskIntervalTypeUnitOfMeasurementCode": { "title": "taskIntervalTypeUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_UnitOfMeasurement_Code" }, "taskIntervalTypeUnitOfMeasurementDescription": { "title": "taskIntervalTypeUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_UnitOfMeasurement_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskInterval->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskInterval->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" } } } }, "GetTaskIntervalForTaskIntervalTypeCollectionResourceActionResponse": { "title": "GetTaskIntervalForTaskIntervalTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTaskIntervalForTaskIntervalTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTaskIntervalForTaskIntervalTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, "taskIntervalTypeUnitOfMeasurementId": { "title": "taskIntervalTypeUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskInterval->TaskIntervalType_UnitOfMeasurement_Id" }, "taskIntervalTypeUnitOfMeasurementCode": { "title": "taskIntervalTypeUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_UnitOfMeasurement_Code" }, "taskIntervalTypeUnitOfMeasurementDescription": { "title": "taskIntervalTypeUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_UnitOfMeasurement_Description" }, "interval": { "title": "interval", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskInterval->Interval" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TaskIntervalChangePermissionTreeLookupResourceActionResponse": { "title": "TaskIntervalChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskIntervalChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskIntervalChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TaskIntervalInsertPermissionTreeLookupResourceActionResponse": { "title": "TaskIntervalInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskIntervalInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskIntervalInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TaskIntervalTaskIntervalTypeLookupResourceActionResponse": { "title": "TaskIntervalTaskIntervalTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskIntervalTaskIntervalTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskIntervalTaskIntervalTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateTaskIntervalResourceActionRequest": { "title": "CreateTaskIntervalResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTaskIntervalResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "interval", "taskIntervalTypeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskInterval->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "TaskInterval->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskInterval->SequenceNumber" }, "interval": { "title": "interval", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskInterval->Interval" }, "taskIntervalTypeId": { "title": "taskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTaskIntervalResourceActionRequest": { "title": "UpdateTaskIntervalResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskInterval->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "TaskInterval->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskInterval->SequenceNumber" }, { "title": "interval", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TaskInterval->Interval" }, { "title": "taskIntervalTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskInterval->TaskIntervalType_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskInterval->Notes" } ] } } }, "DeleteTaskIntervalResourceActionRequest": { "title": "DeleteTaskIntervalResourceActionRequest", "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 } } }, "BatchGetTaskIntervalResourceAction": { "title": "BatchGetTaskIntervalResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Task Interval entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Task Interval entities", "items": { "$ref": "#/definitions/GetTaskIntervalResourceActionResponse" } }, "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" } } }, "BatchCreateTaskIntervalResourceActionRequest": { "title": "BatchCreateTaskIntervalResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTaskIntervalResourceActionRequest" } }, "BatchUpdateTaskIntervalResourceActionRequest": { "title": "BatchUpdateTaskIntervalResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTaskIntervalResourceActionRequest" } }, "BatchDeleteTaskIntervalResourceActionRequest": { "title": "BatchDeleteTaskIntervalResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTaskIntervalResourceActionRequest" } }, "ChangeTaskIntervalIsActiveResourceActionRequest": { "title": "ChangeTaskIntervalIsActiveResourceActionRequest", "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": "TaskInterval->IsActive" } ] } } }, "ChangeTaskIntervalPermissionTreeResourceActionRequest": { "title": "ChangeTaskIntervalPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskInterval->PermissionTree_Id" } ] } } }, "BatchChangeTaskIntervalIsActiveResourceActionRequest": { "title": "BatchChangeTaskIntervalIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskIntervalIsActiveResourceActionRequest" } }, "BatchChangeTaskIntervalPermissionTreeResourceActionRequest": { "title": "BatchChangeTaskIntervalPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskIntervalPermissionTreeResourceActionRequest" } }, "GetTaskIntervalTypeResourceActionResponse": { "title": "GetTaskIntervalTypeResourceActionResponse", "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": "GetTaskIntervalTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TaskIntervalType->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskIntervalType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskIntervalType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskIntervalType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskIntervalType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskIntervalType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->Notes" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TaskIntervalType->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskIntervalType->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Id", "x-NullExpression": "TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage'" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_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" } } }, "GetTaskIntervalTypeCollectionResourceActionResponse": { "title": "GetTaskIntervalTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTaskIntervalTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTaskIntervalTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskIntervalType->SequenceNumber" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TaskIntervalType->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskIntervalType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskIntervalType->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" } } } }, "TaskIntervalTypeChangePermissionTreeLookupResourceActionResponse": { "title": "TaskIntervalTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskIntervalTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskIntervalTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TaskIntervalTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "TaskIntervalTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskIntervalTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskIntervalTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TaskIntervalTypeUnitOfMeasurementLookupResourceActionResponse": { "title": "TaskIntervalTypeUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskIntervalTypeUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskIntervalTypeUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateTaskIntervalTypeResourceActionRequest": { "title": "CreateTaskIntervalTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTaskIntervalTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskIntervalType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskIntervalType->SequenceNumber" }, "schedulingKind": { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TaskIntervalType->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Id", "x-NullExpression": "TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTaskIntervalTypeResourceActionRequest": { "title": "UpdateTaskIntervalTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskIntervalType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskIntervalType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskIntervalType->SequenceNumber" }, { "title": "schedulingKind", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TaskIntervalType->SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskIntervalType->UnitOfMeasurement_Id", "x-NullExpression": "TaskIntervalType->SchedulingKind ne 'Calendar' and TaskIntervalType->SchedulingKind ne 'Usage'" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskIntervalType->Notes" } ] } } }, "DeleteTaskIntervalTypeResourceActionRequest": { "title": "DeleteTaskIntervalTypeResourceActionRequest", "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 } } }, "BatchGetTaskIntervalTypeResourceAction": { "title": "BatchGetTaskIntervalTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Task Interval Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Task Interval Type entities", "items": { "$ref": "#/definitions/GetTaskIntervalTypeResourceActionResponse" } }, "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" } } }, "BatchCreateTaskIntervalTypeResourceActionRequest": { "title": "BatchCreateTaskIntervalTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTaskIntervalTypeResourceActionRequest" } }, "BatchUpdateTaskIntervalTypeResourceActionRequest": { "title": "BatchUpdateTaskIntervalTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTaskIntervalTypeResourceActionRequest" } }, "BatchDeleteTaskIntervalTypeResourceActionRequest": { "title": "BatchDeleteTaskIntervalTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTaskIntervalTypeResourceActionRequest" } }, "ChangeTaskIntervalTypeIsActiveResourceActionRequest": { "title": "ChangeTaskIntervalTypeIsActiveResourceActionRequest", "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": "TaskIntervalType->IsActive" } ] } } }, "ChangeTaskIntervalTypePermissionTreeResourceActionRequest": { "title": "ChangeTaskIntervalTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskIntervalType->PermissionTree_Id" } ] } } }, "BatchChangeTaskIntervalTypeIsActiveResourceActionRequest": { "title": "BatchChangeTaskIntervalTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskIntervalTypeIsActiveResourceActionRequest" } }, "BatchChangeTaskIntervalTypePermissionTreeResourceActionRequest": { "title": "BatchChangeTaskIntervalTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskIntervalTypePermissionTreeResourceActionRequest" } }, "GetTaskRollUpPointResourceActionResponse": { "title": "GetTaskRollUpPointResourceActionResponse", "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": "GetTaskRollUpPointResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskRollUpPoint->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskRollUpPoint->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetTaskRollUpPointCollectionResourceActionResponse": { "title": "GetTaskRollUpPointCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTaskRollUpPointCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTaskRollUpPointCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->Notes" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->PermissionTree_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskRollUpPoint->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TaskRollUpPoint->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" } } } }, "TaskRollUpPointChangePermissionTreeLookupResourceActionResponse": { "title": "TaskRollUpPointChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskRollUpPointChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskRollUpPointChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TaskRollUpPointInsertPermissionTreeLookupResourceActionResponse": { "title": "TaskRollUpPointInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TaskRollUpPointInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TaskRollUpPointInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateTaskRollUpPointResourceActionRequest": { "title": "CreateTaskRollUpPointResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTaskRollUpPointResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTaskRollUpPointResourceActionRequest": { "title": "UpdateTaskRollUpPointResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TaskRollUpPoint->Notes" } ] } } }, "DeleteTaskRollUpPointResourceActionRequest": { "title": "DeleteTaskRollUpPointResourceActionRequest", "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 } } }, "BatchGetTaskRollUpPointResourceAction": { "title": "BatchGetTaskRollUpPointResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Task Roll Up Point entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Task Roll Up Point entities", "items": { "$ref": "#/definitions/GetTaskRollUpPointResourceActionResponse" } }, "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" } } }, "BatchCreateTaskRollUpPointResourceActionRequest": { "title": "BatchCreateTaskRollUpPointResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTaskRollUpPointResourceActionRequest" } }, "BatchUpdateTaskRollUpPointResourceActionRequest": { "title": "BatchUpdateTaskRollUpPointResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTaskRollUpPointResourceActionRequest" } }, "BatchDeleteTaskRollUpPointResourceActionRequest": { "title": "BatchDeleteTaskRollUpPointResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTaskRollUpPointResourceActionRequest" } }, "ChangeTaskRollUpPointIsActiveResourceActionRequest": { "title": "ChangeTaskRollUpPointIsActiveResourceActionRequest", "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": "TaskRollUpPoint->IsActive" } ] } } }, "ChangeTaskRollUpPointPermissionTreeResourceActionRequest": { "title": "ChangeTaskRollUpPointPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TaskRollUpPoint->PermissionTree_Id" } ] } } }, "BatchChangeTaskRollUpPointIsActiveResourceActionRequest": { "title": "BatchChangeTaskRollUpPointIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskRollUpPointIsActiveResourceActionRequest" } }, "BatchChangeTaskRollUpPointPermissionTreeResourceActionRequest": { "title": "BatchChangeTaskRollUpPointPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTaskRollUpPointPermissionTreeResourceActionRequest" } }, "GetTypeOfWorkResourceActionResponse": { "title": "GetTypeOfWorkResourceActionResponse", "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": "GetTypeOfWorkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TypeOfWork->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TypeOfWork->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TypeOfWork->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TypeOfWork->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->Notes" }, "requiresFailedComponent": { "title": "requiresFailedComponent", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailedComponent" }, "requiresFailureCause": { "title": "requiresFailureCause", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCause" }, "requiresFailureCauseType": { "title": "requiresFailureCauseType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCauseType" }, "requiresFailureMechanism": { "title": "requiresFailureMechanism", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanism" }, "requiresFailureMechanismType": { "title": "requiresFailureMechanismType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanismType" }, "requiresFailureMode": { "title": "requiresFailureMode", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMode" }, "requiresFailureModeType": { "title": "requiresFailureModeType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureModeType" }, "requiresRepairType": { "title": "requiresRepairType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresRepairType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TypeOfWork->SequenceNumber" }, "workClass": { "title": "workClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkClass", "x-formatSpecifier": "WorkClass" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Description" }, "workTactic": { "title": "workTactic", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkTactic", "x-formatSpecifier": "WorkTactic" }, "workType": { "title": "workType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkType", "x-formatSpecifier": "WorkType" } } }, "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" } } }, "GetTypeOfWorkCollectionResourceActionResponse": { "title": "GetTypeOfWorkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTypeOfWorkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTypeOfWorkCollectionResourceActionResponseItemProperties", "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" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->Notes" }, "requiresFailedComponent": { "title": "requiresFailedComponent", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailedComponent" }, "requiresFailureModeType": { "title": "requiresFailureModeType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureModeType" }, "requiresFailureMode": { "title": "requiresFailureMode", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMode" }, "requiresFailureMechanismType": { "title": "requiresFailureMechanismType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanismType" }, "requiresFailureMechanism": { "title": "requiresFailureMechanism", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanism" }, "requiresFailureCauseType": { "title": "requiresFailureCauseType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCauseType" }, "requiresFailureCause": { "title": "requiresFailureCause", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCause" }, "requiresRepairType": { "title": "requiresRepairType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresRepairType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TypeOfWork->SequenceNumber" }, "workClass": { "title": "workClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkClass", "x-formatSpecifier": "WorkClass" }, "workTactic": { "title": "workTactic", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkTactic", "x-formatSpecifier": "WorkTactic" }, "workType": { "title": "workType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkType", "x-formatSpecifier": "WorkType" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Id" }, "workOrderStatusCode": { "title": "workOrderStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Code" }, "workOrderStatusDescription": { "title": "workOrderStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TypeOfWork->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TypeOfWork->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" } } } }, "TypeOfWorkChangePermissionTreeLookupResourceActionResponse": { "title": "TypeOfWorkChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TypeOfWorkChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TypeOfWorkChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TypeOfWorkInsertPermissionTreeLookupResourceActionResponse": { "title": "TypeOfWorkInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TypeOfWorkInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TypeOfWorkInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TypeOfWorkWorkOrderStatusLookupResourceActionResponse": { "title": "TypeOfWorkWorkOrderStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TypeOfWorkWorkOrderStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "TypeOfWorkWorkOrderStatusLookupResourceActionResponseItemProperties", "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" } } } }, "CreateTypeOfWorkResourceActionRequest": { "title": "CreateTypeOfWorkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTypeOfWorkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "workClass" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TypeOfWork->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" }, "requiresFailedComponent": { "title": "requiresFailedComponent", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailedComponent" }, "requiresFailureModeType": { "title": "requiresFailureModeType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureModeType" }, "requiresFailureMode": { "title": "requiresFailureMode", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMode" }, "requiresFailureMechanismType": { "title": "requiresFailureMechanismType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanismType" }, "requiresFailureMechanism": { "title": "requiresFailureMechanism", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanism" }, "requiresFailureCauseType": { "title": "requiresFailureCauseType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCauseType" }, "requiresFailureCause": { "title": "requiresFailureCause", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCause" }, "requiresRepairType": { "title": "requiresRepairType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresRepairType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TypeOfWork->SequenceNumber" }, "workClass": { "title": "workClass", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TypeOfWork->WorkClass", "x-formatSpecifier": "WorkClass" }, "workTactic": { "title": "workTactic", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkTactic", "x-formatSpecifier": "WorkTactic" }, "workType": { "title": "workType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkType", "x-formatSpecifier": "WorkType" }, "workOrderStatusId": { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTypeOfWorkResourceActionRequest": { "title": "UpdateTypeOfWorkResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TypeOfWork->Description" }, { "title": "requiresFailedComponent", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailedComponent" }, { "title": "requiresFailureModeType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureModeType" }, { "title": "requiresFailureMode", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMode" }, { "title": "requiresFailureMechanismType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanismType" }, { "title": "requiresFailureMechanism", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureMechanism" }, { "title": "requiresFailureCauseType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCauseType" }, { "title": "requiresFailureCause", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresFailureCause" }, { "title": "requiresRepairType", "type": "boolean", "x-nullable": true, "x-propertyPath": "TypeOfWork->RequiresRepairType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TypeOfWork->SequenceNumber" }, { "title": "workClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkClass", "x-formatSpecifier": "WorkClass" }, { "title": "workTactic", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkTactic", "x-formatSpecifier": "WorkTactic" }, { "title": "workType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkType", "x-formatSpecifier": "WorkType" }, { "title": "workOrderStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TypeOfWork->WorkOrderStatus_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TypeOfWork->Notes" } ] } } }, "DeleteTypeOfWorkResourceActionRequest": { "title": "DeleteTypeOfWorkResourceActionRequest", "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 } } }, "BatchGetTypeOfWorkResourceAction": { "title": "BatchGetTypeOfWorkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Type of Work entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Type of Work entities", "items": { "$ref": "#/definitions/GetTypeOfWorkResourceActionResponse" } }, "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" } } }, "BatchCreateTypeOfWorkResourceActionRequest": { "title": "BatchCreateTypeOfWorkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTypeOfWorkResourceActionRequest" } }, "BatchUpdateTypeOfWorkResourceActionRequest": { "title": "BatchUpdateTypeOfWorkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTypeOfWorkResourceActionRequest" } }, "BatchDeleteTypeOfWorkResourceActionRequest": { "title": "BatchDeleteTypeOfWorkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTypeOfWorkResourceActionRequest" } }, "ChangeTypeOfWorkIsActiveResourceActionRequest": { "title": "ChangeTypeOfWorkIsActiveResourceActionRequest", "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": "TypeOfWork->IsActive" } ] } } }, "ChangeTypeOfWorkPermissionTreeResourceActionRequest": { "title": "ChangeTypeOfWorkPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TypeOfWork->PermissionTree_Id" } ] } } }, "BatchChangeTypeOfWorkIsActiveResourceActionRequest": { "title": "BatchChangeTypeOfWorkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTypeOfWorkIsActiveResourceActionRequest" } }, "BatchChangeTypeOfWorkPermissionTreeResourceActionRequest": { "title": "BatchChangeTypeOfWorkPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTypeOfWorkPermissionTreeResourceActionRequest" } }, "GetWarrantyTypeResourceActionResponse": { "title": "GetWarrantyTypeResourceActionResponse", "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": "GetWarrantyTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WarrantyType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "WarrantyType->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WarrantyType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarrantyType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WarrantyType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WarrantyType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WarrantyType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WarrantyType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WarrantyType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetWarrantyTypeCollectionResourceActionResponse": { "title": "GetWarrantyTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetWarrantyTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetWarrantyTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WarrantyType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WarrantyType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WarrantyType->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" } } } }, "WarrantyTypeChangePermissionTreeLookupResourceActionResponse": { "title": "WarrantyTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarrantyTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WarrantyTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "WarrantyTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "WarrantyTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "WarrantyTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "WarrantyTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateWarrantyTypeResourceActionRequest": { "title": "CreateWarrantyTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateWarrantyTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WarrantyType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WarrantyType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WarrantyType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WarrantyType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateWarrantyTypeResourceActionRequest": { "title": "UpdateWarrantyTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "WarrantyType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "WarrantyType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "WarrantyType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "WarrantyType->Notes" } ] } } }, "DeleteWarrantyTypeResourceActionRequest": { "title": "DeleteWarrantyTypeResourceActionRequest", "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 } } }, "BatchGetWarrantyTypeResourceAction": { "title": "BatchGetWarrantyTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Warranty Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Warranty Type entities", "items": { "$ref": "#/definitions/GetWarrantyTypeResourceActionResponse" } }, "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" } } }, "BatchCreateWarrantyTypeResourceActionRequest": { "title": "BatchCreateWarrantyTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateWarrantyTypeResourceActionRequest" } }, "BatchUpdateWarrantyTypeResourceActionRequest": { "title": "BatchUpdateWarrantyTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateWarrantyTypeResourceActionRequest" } }, "BatchDeleteWarrantyTypeResourceActionRequest": { "title": "BatchDeleteWarrantyTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteWarrantyTypeResourceActionRequest" } }, "ChangeWarrantyTypeIsActiveResourceActionRequest": { "title": "ChangeWarrantyTypeIsActiveResourceActionRequest", "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": "WarrantyType->IsActive" } ] } } }, "ChangeWarrantyTypePermissionTreeResourceActionRequest": { "title": "ChangeWarrantyTypePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "WarrantyType->PermissionTree_Id" } ] } } }, "BatchChangeWarrantyTypeIsActiveResourceActionRequest": { "title": "BatchChangeWarrantyTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWarrantyTypeIsActiveResourceActionRequest" } }, "BatchChangeWarrantyTypePermissionTreeResourceActionRequest": { "title": "BatchChangeWarrantyTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeWarrantyTypePermissionTreeResourceActionRequest" } } }, "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": "Asset Warranty" }, { "name": "Condition" }, { "name": "Condition Type" }, { "name": "Event" }, { "name": "Failure Cause" }, { "name": "Failure Cause Type" }, { "name": "Failure Mechanism" }, { "name": "Failure Mechanism Type" }, { "name": "Failure Mode" }, { "name": "Failure Mode Type" }, { "name": "Option" }, { "name": "Option Category" }, { "name": "Repair Type" }, { "name": "Rule" }, { "name": "Rule Category" }, { "name": "Rule Option" }, { "name": "Standard Task" }, { "name": "Standard Task Resource" }, { "name": "Standard Task Spare" }, { "name": "Standard Task Sub Task" }, { "name": "Task Importance" }, { "name": "Task Interval" }, { "name": "Task Interval Type" }, { "name": "Task Roll Up Point" }, { "name": "Type of Work" }, { "name": "Warranty Type" } ], "x-tagGroups": [ { "name": "AMPC.Shared", "tags": [ "Asset Warranty", "Condition", "Condition Type", "Event", "Failure Cause", "Failure Cause Type", "Failure Mechanism", "Failure Mechanism Type", "Failure Mode", "Failure Mode Type", "Option", "Option Category", "Repair Type", "Rule", "Rule Category", "Rule Option", "Standard Task", "Standard Task Resource", "Standard Task Spare", "Standard Task Sub Task", "Task Importance", "Task Interval", "Task Interval Type", "Task Roll Up Point", "Type of Work", "Warranty Type" ] } ] }